diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 81d5d80ec..a684c5d79 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.6.0", + "version": "17.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": { @@ -163,6 +163,18 @@ { "name": "desktop", "description": "Desktop specific endpoints." + }, + { + "name": "enterprise-teams", + "description": "Endpoints to manage GitHub Enterprise Teams." + }, + { + "name": "code-security", + "description": "Endpoints to manage Code security using the REST API." + }, + { + "name": "private-registries", + "description": "Manage private registry configurations." } ], "servers": [ @@ -348,6 +360,22 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/pagination-before" }, @@ -377,7 +405,9 @@ "type": "string", "enum": [ "updated", - "published" + "published", + "epss_percentage", + "epss_percentile" ], "default": "published" } @@ -719,14 +749,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -1758,7 +1780,7 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], @@ -1925,7 +1947,7 @@ "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", - "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" @@ -1985,7 +2007,7 @@ "/applications/{client_id}/token": { "post": { "summary": "Check a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -2058,7 +2080,7 @@ }, "patch": { "summary": "Reset a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -2128,7 +2150,7 @@ }, "delete": { "summary": "Delete an app token", - "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.", + "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], @@ -2188,7 +2210,7 @@ "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", - "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -2307,7 +2329,7 @@ "/apps/{app_slug}": { "get": { "summary": "Get an app", - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", + "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "tags": [ "apps" ], @@ -2785,50 +2807,864 @@ "x-octokit": {} } }, - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations": { "get": { - "summary": "Get a summary of Copilot usage for enterprise members", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage\nmetrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.", + "summary": "Get code security configurations for an enterprise", + "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ - "copilot" + "code-security" ], - "operationId": "copilot/usage-metrics-for-enterprise", + "operationId": "code-security/get-configurations-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members" + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" }, "parameters": [ { "$ref": "#/components/parameters/enterprise" }, { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "name": "per_page", "in": "query", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration-list" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a code security configuration for an enterprise", + "description": "Creates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ], + "default": "disabled" + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "High rish settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations for an enterprise", + "description": "Lists the default code security configurations for an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-default-configurations" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-default-configurations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Retrieve a code security configuration of an enterprise", + "description": "Gets a code security configuration available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-single-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a custom code security configuration for an enterprise", + "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique across the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.", + "enum": [ + "enabled", + "disabled" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-enterprise recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a code security configuration for an enterprise", + "description": "Deletes a code security configuration from an enterprise.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/delete-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach an enterprise configuration to repositories", + "description": "Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/attach-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations" + ] + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "all" + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an enterprise", + "description": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.\n\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with an enterprise code security configuration", + "description": "Lists the repositories associated with an enterprise code security configuration in an organization.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { - "type": "string" + "type": "integer", + "default": 30 } }, { - "$ref": "#/components/parameters/page" + "$ref": "#/components/parameters/pagination-before" }, { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", "in": "query", + "required": false, "schema": { - "type": "integer", - "default": 28 + "type": "string", + "default": "all" } } ], @@ -2840,35 +3676,37 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/copilot-usage-metrics" + "$ref": "#/components/schemas/code-security-configuration-repositories" } }, "examples": { "default": { - "$ref": "#/components/examples/copilot-usage-metrics-enterprise" + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "$ref": "#/components/examples/simple-repository" + } + } + ] } } } } }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, "403": { "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" - }, - "500": { - "$ref": "#/components/responses/internal_error" } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" }, "x-octokit": {} } @@ -3010,6 +3848,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" } ], "responses": { @@ -3055,7 +3899,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -3113,7 +3957,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -3213,7 +4057,7 @@ }, "post": { "summary": "Create a gist", - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "description": "Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", "operationId": "gists/create", "tags": [ "gists" @@ -4611,7 +5455,7 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -5056,7 +5900,7 @@ "/marketplace_listing/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -5112,7 +5956,7 @@ "/marketplace_listing/plans": { "get": { "summary": "List plans", - "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -5172,7 +6016,7 @@ "/marketplace_listing/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan", - "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -5254,7 +6098,7 @@ "/marketplace_listing/stubbed/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account (stubbed)", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -5303,7 +6147,7 @@ "/marketplace_listing/stubbed/plans": { "get": { "summary": "List plans (stubbed)", - "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -5360,7 +6204,7 @@ "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan (stubbed)", - "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -5436,7 +6280,7 @@ "/meta": { "get": { "summary": "Get GitHub meta information", - "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n**Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", "tags": [ "meta" ], @@ -5478,7 +6322,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -6041,7 +6885,7 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -6098,10 +6942,65 @@ "x-octokit": {} } }, + "/organizations/{org}/settings/billing/usage": { + "get": { + "summary": "Get billing usage report for an organization", + "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).\"", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-usage-report-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + }, + { + "$ref": "#/components/parameters/billing-usage-report-hour" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_usage_report_org" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + }, + "x-octokit": {} + } + }, "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -6145,7 +7044,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -6232,7 +7131,7 @@ }, "members_allowed_repository_creation_type": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", "private", @@ -6270,27 +7169,33 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -6299,6 +7204,10 @@ "secret_scanning_push_protection_custom_link": { "type": "string", "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -7090,30 +7999,594 @@ "x-octokit": {} } }, - "/orgs/{org}/actions/runners": { + "/orgs/{org}/actions/runner-groups": { "get": { - "summary": "List self-hosted runners for an organization", - "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "summary": "List self-hosted runner groups for an organization", + "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", "tags": [ "actions" ], - "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" }, "parameters": [ { - "name": "name", - "description": "The name of a self-hosted runner.", - "in": "query", - "schema": { - "type": "string" + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/visible-to-repository" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runner_groups" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-groups-org" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-groups-org" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-item" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ { "$ref": "#/components/parameters/org" }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-paginated" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, { "$ref": "#/components/parameters/per-page" }, @@ -7134,7 +8607,221 @@ ], "properties": { "total_count": { - "type": "integer" + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set self-hosted runners in a group for an organization", + "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "runners" + ] + }, + "examples": { + "default": { + "value": { + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/actions/runners": { + "get": { + "summary": "List self-hosted runners for an organization", + "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + }, + "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" }, "runners": { "type": "array", @@ -8789,6 +10476,103 @@ "x-octokit": {} } }, + "/orgs/{org}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, "/orgs/{org}/blocks": { "get": { "summary": "List users blocked by an organization", @@ -9062,6 +10846,1077 @@ "x-octokit": {} } }, + "/orgs/{org}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "in": "query", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-list" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ], + "default": "disabled" + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-default-configurations" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-default-configurations" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/detach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to detach from configurations.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + } + }, + "examples": { + "default": { + "summary": "Example for detaching repositories from configurations.", + "value": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-updated" + } + } + } + } + }, + "204": { + "description": "Response when no new updates are made" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/delete-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/attach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations", + "public", + "private_or_internal", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "selected", + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration-repositories" + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "$ref": "#/components/examples/simple-repository" + } + } + ] + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, "/orgs/{org}/codespaces": { "get": { "summary": "List codespaces for the organization", @@ -9947,7 +12802,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -10005,7 +12860,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -10089,7 +12944,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -10144,7 +12999,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -10190,7 +13045,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -10245,7 +13100,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -10293,7 +13148,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -10348,7 +13203,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -10394,7 +13249,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -10449,7 +13304,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -10494,10 +13349,98 @@ "x-octokit": {} } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + }, + "x-octokit": {} + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nCopilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view\nCopilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -11249,7 +14192,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -11361,7 +14304,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -11715,7 +14658,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -11898,14 +14841,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -12078,6 +15013,519 @@ "x-octokit": {} } }, + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get route stats by actor", + "description": "Get API request count statistics for an actor broken down by route within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-route-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-route-stats-sort" + }, + { + "$ref": "#/components/parameters/api-insights-api-route-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-route-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-route-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/subject-stats": { + "get": { + "summary": "Get subject stats", + "description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-subject-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-sort" + }, + { + "$ref": "#/components/parameters/api-insights-subject-name-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-subject-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-subject-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/summary-stats": { + "get": { + "summary": "Get summary stats", + "description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + "get": { + "summary": "Get summary stats by user", + "description": "Get overall statistics of API requests within the organization for a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get summary stats by actor", + "description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/time-stats": { + "get": { + "summary": "Get time stats", + "description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + "get": { + "summary": "Get time stats by user", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get time stats by actor", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/user-stats/{user_id}": { + "get": { + "summary": "Get user stats", + "description": "Get API usage statistics within an organization for a user broken down by the type of access.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-user-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-user-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-sort" + }, + { + "$ref": "#/components/parameters/api-insights-actor-name-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-user-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-user-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, "/orgs/{org}/installation": { "get": { "summary": "Get an organization installation for the authenticated app", @@ -12336,7 +15784,7 @@ "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.", "tags": [ "orgs" ], @@ -12426,7 +15874,7 @@ }, "post": { "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "orgs" ], @@ -12630,7 +16078,7 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -13117,7 +16565,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13228,7 +16676,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -13786,62 +17234,10 @@ "x-octokit": {} } }, - "/orgs/{org}/organization-fine-grained-permissions": { - "get": { - "summary": "List organization fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-organization-fine-grained-permissions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/organization-fine-grained-permission" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/organization-fine-grained-permission-example" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - }, - "x-octokit": {} - } - }, "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -13898,133 +17294,12 @@ "subcategory": "organization-roles" }, "x-octokit": {} - }, - "post": { - "summary": "Create a custom organization role", - "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/create-custom-organization-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the custom role." - }, - "description": { - "type": "string", - "description": "A short description about the intended usage of this role or what permissions it grants." - }, - "permissions": { - "type": "array", - "description": "A list of additional permissions included in this role.", - "items": { - "type": "string" - } - } - }, - "required": [ - "name", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ] - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/organization-role" - }, - "examples": { - "default": { - "value": { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:19:11Z" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - }, - "x-octokit": {} } }, "/orgs/{org}/organization-roles/teams/{team_slug}": { "delete": { "summary": "Remove all organization roles for a team", - "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14058,7 +17333,7 @@ "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { "put": { "summary": "Assign an organization role to a team", - "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14099,7 +17374,7 @@ }, "delete": { "summary": "Remove an organization role from a team", - "description": "Removes an organization role from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14136,7 +17411,7 @@ "/orgs/{org}/organization-roles/users/{username}": { "delete": { "summary": "Remove all organization roles for a user", - "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14170,7 +17445,7 @@ "/orgs/{org}/organization-roles/users/{username}/{role_id}": { "put": { "summary": "Assign an organization role to a user", - "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14211,7 +17486,7 @@ }, "delete": { "summary": "Remove an organization role from a user", - "description": "Remove an organization role from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14248,7 +17523,7 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14295,157 +17570,12 @@ "subcategory": "organization-roles" }, "x-octokit": {} - }, - "patch": { - "summary": "Update a custom organization role", - "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/patch-custom-organization-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/role-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the custom role." - }, - "description": { - "type": "string", - "description": "A short description about the intended usage of this role or what permissions it grants." - }, - "permissions": { - "type": "array", - "description": "A list of additional permissions included in this role.", - "items": { - "type": "string" - } - } - } - }, - "examples": { - "default": { - "value": { - "description": "Permissions to manage custom roles within an org." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/organization-role" - }, - "examples": { - "default": { - "value": { - "id": 8030, - "name": "Custom Role Manager", - "description": "Permissions to manage custom roles within an org", - "permissions": [ - "write_organization_custom_repo_role", - "write_organization_custom_org_role", - "read_organization_custom_repo_role", - "read_organization_custom_org_role" - ], - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "created_at": "2022-07-04T22:19:11Z", - "updated_at": "2022-07-04T22:19:11Z" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Delete a custom organization role.", - "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/delete-custom-organization-role", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/role-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "organization-roles" - }, - "x-octokit": {} } }, "/orgs/{org}/organization-roles/{role_id}/teams": { "get": { "summary": "List teams that are assigned to an organization role", - "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14477,7 +17607,7 @@ "type": "array", "description": "List of teams assigned to the organization role", "items": { - "$ref": "#/components/schemas/team" + "$ref": "#/components/schemas/team-role-assignment" } }, "examples": { @@ -14512,7 +17642,7 @@ "/orgs/{org}/organization-roles/{role_id}/users": { "get": { "summary": "List users that are assigned to an organization role", - "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -14544,7 +17674,7 @@ "type": "array", "description": "List of users assigned to the organization role", "items": { - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/user-role-assignment" } }, "examples": { @@ -14794,7 +17924,7 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -14887,7 +18017,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -14934,7 +18064,7 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -14980,7 +18110,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -15035,7 +18165,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -15126,7 +18256,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -15176,7 +18306,7 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -15225,7 +18355,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -15945,6 +19075,462 @@ "x-octokit": {} } }, + "/orgs/{org}/private-registries": { + "get": { + "summary": "List private registries for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/list-org-private-registries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-private-registry-configuration" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configurations-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/create-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository" + ] + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": "string", + "nullable": true + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + }, + "required": [ + "registry_type", + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration" + }, + "org-private-registry-with-private-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/private-registries-public-key" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configuration" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository" + ] + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": "string", + "nullable": true + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/delete-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + } + }, "/orgs/{org}/projects": { "get": { "summary": "List organization projects", @@ -16132,12 +19718,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" } }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" } } } @@ -16185,7 +19771,7 @@ "type": "array", "description": "The array of custom properties to create or update.", "items": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "minItems": 1, "maxItems": 100 @@ -16235,12 +19821,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" } }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" } } } @@ -16288,11 +19874,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" } } } @@ -16337,55 +19923,7 @@ "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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "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", - "maxLength": 75 - }, - "maxItems": 200, - "nullable": true, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - } - }, - "required": [ - "value_type" - ] + "$ref": "#/components/schemas/custom-property-set-payload" }, "examples": { "default": { @@ -16410,11 +19948,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" } } } @@ -16785,7 +20323,7 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], @@ -17003,7 +20541,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -17013,7 +20551,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -17030,7 +20568,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -17134,6 +20672,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -17200,12 +20741,14 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", - "push" - ] + "push", + "repository" + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -17324,6 +20867,9 @@ { "$ref": "#/components/parameters/org" }, + { + "$ref": "#/components/parameters/ref-in-query" + }, { "$ref": "#/components/parameters/repository-name-in-query" }, @@ -17430,7 +20976,7 @@ "/orgs/{org}/rulesets/{ruleset_id}": { "get": { "summary": "Get an organization repository ruleset", - "description": "Get a repository ruleset for an organization.", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], @@ -17529,11 +21075,12 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -17722,6 +21269,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" } ], "responses": { @@ -17870,7 +21423,7 @@ "/orgs/{org}/security-managers": { "get": { "summary": "List security manager teams", - "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], @@ -17909,15 +21462,18 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "security-managers" + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" }, + "deprecated": true, "x-octokit": {} } }, "/orgs/{org}/security-managers/teams/{team_slug}": { "put": { "summary": "Add a security manager team", - "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], @@ -17937,9 +21493,6 @@ "responses": { "204": { "description": "Response" - }, - "409": { - "description": "The organization has reached the maximum number of security manager teams." } }, "x-github": { @@ -17947,13 +21500,16 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "security-managers" + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Remove a security manager team", - "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], @@ -17980,8 +21536,11 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "security-managers" + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -18114,10 +21673,101 @@ "x-octokit": {} } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + }, + "x-octokit": {} + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n**Note**: This endpoint will only return results for a given day if the team had five or more members on that day.\n\nCopilot Business or Copilot Enterprise organization owners for the organization that contains this team,\nand owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -18327,7 +21977,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push" @@ -18392,7 +22042,7 @@ "/orgs/{org}/teams/{team_slug}": { "get": { "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -18439,7 +22089,7 @@ }, "patch": { "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -18489,7 +22139,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -18568,7 +22218,7 @@ }, "delete": { "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -18602,7 +22252,7 @@ "/orgs/{org}/teams/{team_slug}/discussions": { "get": { "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -18672,7 +22322,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -18756,7 +22406,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -18803,7 +22453,7 @@ }, "patch": { "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -18877,7 +22527,7 @@ }, "delete": { "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -18914,7 +22564,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -18978,7 +22628,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -19054,7 +22704,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -19104,7 +22754,7 @@ }, "patch": { "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -19180,7 +22830,7 @@ }, "delete": { "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -19220,7 +22870,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -19303,7 +22953,7 @@ }, "post": { "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -19406,7 +23056,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -19449,7 +23099,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -19529,7 +23179,7 @@ }, "post": { "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -19629,7 +23279,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -19669,7 +23319,7 @@ "/orgs/{org}/teams/{team_slug}/invitations": { "get": { "summary": "List pending team invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", "tags": [ "teams" ], @@ -19804,7 +23454,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", "tags": [ "teams" ], @@ -19854,7 +23504,7 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using 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.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using 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.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], @@ -19936,7 +23586,7 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using 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.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using 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.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], @@ -19976,7 +23626,7 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "tags": [ "teams" ], @@ -20036,7 +23686,7 @@ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -20086,7 +23736,7 @@ }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -20177,7 +23827,7 @@ }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -20214,7 +23864,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], @@ -20274,7 +23924,7 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], @@ -20330,7 +23980,7 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], @@ -20362,8 +24012,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "default": "push" + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." } } }, @@ -20393,7 +24042,7 @@ }, "delete": { "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], @@ -20433,7 +24082,7 @@ "/orgs/{org}/teams/{team_slug}/teams": { "get": { "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], @@ -20493,7 +24142,7 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], @@ -20550,8 +24199,11 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "orgs" + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" }, + "deprecated": true, "x-octokit": {} } }, @@ -22096,7 +25748,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -22152,7 +25804,7 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], @@ -22288,6 +25940,26 @@ "description": "Can be `enabled` or `disabled`." } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } } } }, @@ -22347,7 +26019,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -22357,7 +26029,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -22374,7 +26046,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -24469,7 +28141,7 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], @@ -25073,7 +28745,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], @@ -26557,7 +30229,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs for a workflow", - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], @@ -26937,6 +30609,208 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/attestations": { + "post": { + "summary": "Create an attestation", + "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "repos" + ], + "operationId": "repos/create-attestation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#create-an-attestation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + } + }, + "required": [ + "bundle" + ] + }, + "examples": { + "default": { + "summary": "Example of a request body", + "value": { + "$ref": "#/components/examples/attestation" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the attestation." + } + } + }, + "examples": { + "default": { + "value": { + "id": 2 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "repos" + ], + "operationId": "repos/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/autolinks": { "get": { "summary": "Get all autolinks of a repository", @@ -27191,7 +31065,7 @@ ], "responses": { "200": { - "description": "Response if dependabot is enabled", + "description": "Response if Dependabot is enabled", "content": { "application/json": { "schema": { @@ -27209,7 +31083,7 @@ } }, "404": { - "description": "Not Found if dependabot is not enabled for the repository" + "description": "Not Found if Dependabot is not enabled for the repository" } }, "x-github": { @@ -27306,7 +31180,7 @@ }, { "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "description": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", "required": false, "schema": { @@ -27465,7 +31339,7 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], @@ -27504,7 +31378,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -28002,7 +31876,7 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], @@ -28207,7 +32081,7 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], @@ -28431,7 +32305,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -28912,7 +32786,7 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], @@ -29073,32 +32947,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -29167,32 +33037,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -29261,31 +33127,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -29748,32 +33611,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -29843,32 +33702,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -29938,31 +33793,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -30013,7 +33865,7 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], @@ -30415,7 +34267,7 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}": { "get": { "summary": "Get a check run", - "description": "Gets a single check run using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -30462,7 +34314,7 @@ }, "patch": { "summary": "Update a check run", - "description": "Updates a check run for a specific commit in a 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -30910,7 +34762,7 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -31089,7 +34941,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { "get": { "summary": "Get a check suite", - "description": "Gets a single check suite using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -31138,7 +34990,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "Lists check runs for a check suite using its `id`.\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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -31543,6 +35395,223 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + "get": { + "summary": "Get the status of an autofix for a code scanning alert", + "description": "Gets the status and description of an autofix for a code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an autofix for a code scanning alert", + "description": "Creates an autofix for a code scanning alert.\n\nIf a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.\n\nIf an autofix already exists for a given alert, then this endpoint will return a 200 OK response.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/create-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix" + } + } + } + } + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-pending" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_autofix_create_forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + "post": { + "summary": "Commit an autofix for a code scanning alert", + "description": "Commits an autofix for a code scanning alert.\n\nIf an autofix is commited as a result of this request, then this endpoint will return a 201 Created response.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/commit-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix-commits" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-commits" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix-commits-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-commits-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { "get": { "summary": "List instances of a code scanning alert", @@ -31573,6 +35642,9 @@ }, { "$ref": "#/components/parameters/git-ref" + }, + { + "$ref": "#/components/parameters/pr-alias" } ], "responses": { @@ -31626,7 +35698,7 @@ "/repos/{owner}/{repo}/code-scanning/analyses": { "get": { "summary": "List code scanning analyses for a repository", - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/list-recent-analyses", "tags": [ "code-scanning" @@ -31654,6 +35726,9 @@ { "$ref": "#/components/parameters/per-page" }, + { + "$ref": "#/components/parameters/pr-alias" + }, { "name": "ref", "in": "query", @@ -31880,7 +35955,7 @@ "/repos/{owner}/{repo}/code-scanning/codeql/databases": { "get": { "summary": "List CodeQL databases for a repository", - "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], @@ -31939,7 +36014,7 @@ "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { "get": { "summary": "Get a CodeQL database for a repository", - "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], @@ -32002,6 +36077,380 @@ "subcategory": "code-scanning" }, "x-octokit": {} + }, + "delete": { + "summary": "Delete a CodeQL database", + "description": "Deletes a CodeQL database for a language in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/delete-codeql-database", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "language", + "in": "path", + "description": "The language of the CodeQL database.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + "post": { + "summary": "Create a CodeQL variant analysis", + "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/create-variant-analysis", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "language": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-language" + }, + "query_pack": { + "description": "A Base64-encoded tarball containing a CodeQL query and all its dependencies", + "type": "string" + }, + "repositories": { + "type": "array", + "description": "List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "items": { + "type": "string" + } + }, + "repository_lists": { + "description": "List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "repository_owners": { + "description": "List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "language", + "query_pack" + ], + "oneOf": [ + { + "required": [ + "repositories" + ] + }, + { + "required": [ + "repository_lists" + ] + }, + { + "required": [ + "repository_owners" + ] + } + ] + }, + "examples": { + "repositories_parameter": { + "summary": "Using the \"repositories\" field. \"query_pack\" is abridged for brevity.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repositories": [ + "octocat/Hello-World", + "octocat/example" + ] + } + }, + "repository_owners": { + "summary": "Using the \"repository_owners\" field. \"query_pack\" is abridged.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repository_owners": [ + "octocat" + ] + } + }, + "repository_lists": { + "summary": "Using the \"repository_lists\" field. \"query_pack\" is abridged.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repository_lists": [ + "top-100-csharp" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Variant analysis submitted for processing", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis" + }, + "examples": { + "repositories_parameter": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + }, + "repository_owners": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + }, + "repository_lists": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unable to process variant analysis submission", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + "get": { + "summary": "Get the summary of a CodeQL variant analysis", + "description": "Gets the summary of a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-variant-analysis", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "codeql_variant_analysis_id", + "in": "path", + "description": "The unique identifier of the variant analysis.", + "schema": { + "type": "integer" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + "get": { + "summary": "Get the analysis status of a repository in a CodeQL variant analysis", + "description": "Gets the analysis status of a repository in a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-variant-analysis-repo-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "name": "repo", + "in": "path", + "description": "The name of the controller repository.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "codeql_variant_analysis_id", + "in": "path", + "description": "The ID of the variant analysis.", + "schema": { + "type": "integer" + }, + "required": true + }, + { + "name": "repo_owner", + "in": "path", + "description": "The account owner of the variant analysis repository. The name is not case sensitive.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "repo_name", + "in": "path", + "description": "The name of the variant analysis repository.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repo-task" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-variant-analysis-repo-task" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} } }, "/repos/{owner}/{repo}/code-scanning/default-setup": { @@ -32148,7 +36597,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -32325,6 +36774,64 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/code-security-configuration": { + "get": { + "summary": "Get the code security configuration associated with a repository", + "description": "Get the code security configuration that manages a repository's code security settings.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configuration-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-for-repository" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/codeowners/errors": { "get": { "summary": "List CODEOWNERS errors", @@ -32498,7 +37005,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -33056,7 +37563,7 @@ "/repos/{owner}/{repo}/codespaces/secrets/public-key": { "get": { "summary": "Get a repository public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "codespaces" ], @@ -33397,7 +37904,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -33479,7 +37986,7 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n**Note**: A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], @@ -33986,7 +38493,7 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], @@ -34026,7 +38533,7 @@ "/repos/{owner}/{repo}/commits": { "get": { "summary": "List commits", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -34079,11 +38586,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -34266,7 +38780,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -34307,7 +38821,7 @@ }, "line": { "type": "integer", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." + "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ @@ -34437,7 +38951,7 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -34507,7 +39021,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -34610,7 +39124,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -34868,7 +39382,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -35007,7 +39521,16 @@ { "$ref": "#/components/schemas/content-submodule" } - ] + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "array": "#/components/schemas/content-directory", + "file": "#/components/schemas/content-file", + "symlink": "#/components/schemas/content-symlink", + "submodule": "#/components/schemas/content-submodule" + } + } }, "examples": { "response-if-content-is-a-file": { @@ -35029,6 +39552,9 @@ "302": { "$ref": "#/components/responses/found" }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -35046,7 +39572,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], @@ -35209,7 +39735,21 @@ "$ref": "#/components/responses/not_found" }, "409": { - "$ref": "#/components/responses/conflict" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/basic-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } }, "422": { "$ref": "#/components/responses/validation_failed" @@ -35225,7 +39765,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -35481,7 +40021,7 @@ }, { "name": "page", - "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", "deprecated": true, "in": "query", "schema": { @@ -36685,7 +41225,7 @@ }, "target_url": { "type": "string", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.", "default": "" }, "log_url": { @@ -36864,7 +41404,7 @@ }, "client_payload": { "type": "object", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.", "additionalProperties": true, "maxProperties": 10 } @@ -36972,7 +41512,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}": { "get": { "summary": "Get an environment", - "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], @@ -37019,7 +41559,7 @@ }, "put": { "summary": "Create or update an environment", - "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], @@ -37657,7 +42197,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { "get": { "summary": "List custom deployment rule integrations available for an environment", - "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], @@ -38425,7 +42965,7 @@ "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", - "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -38557,7 +43097,7 @@ }, "post": { "summary": "Create a fork", - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", + "description": "Create a fork for the authenticated user.\n\n> [!NOTE]\n> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", "tags": [ "repos" ], @@ -38732,7 +43272,21 @@ "$ref": "#/components/responses/conflict" }, "422": { - "$ref": "#/components/responses/validation_failed" + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } } }, "x-github": { @@ -38813,7 +43367,7 @@ "/repos/{owner}/{repo}/git/commits": { "post": { "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -38847,7 +43401,7 @@ }, "parents": { "type": "array", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", "items": { "type": "string" } @@ -38970,7 +43524,7 @@ "/repos/{owner}/{repo}/git/commits/{commit_sha}": { "get": { "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -39025,7 +43579,7 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], @@ -39085,7 +43639,7 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], @@ -39360,7 +43914,7 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -39497,7 +44051,7 @@ "/repos/{owner}/{repo}/git/tags/{tag_sha}": { "get": { "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -39625,7 +44179,7 @@ }, "base_tree": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n" + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." } }, "required": [ @@ -39699,7 +44253,7 @@ "/repos/{owner}/{repo}/git/trees/{tree_sha}": { "get": { "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", "tags": [ "git" ], @@ -40125,7 +44679,7 @@ }, "delete": { "summary": "Delete a repository webhook", - "description": "", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", "tags": [ "repos" ], @@ -40319,14 +44873,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -40511,7 +45057,7 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { "post": { "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", "tags": [ "repos" ], @@ -40551,7 +45097,7 @@ "/repos/{owner}/{repo}/import": { "get": { "summary": "Get an import status", - "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.", + "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -40604,7 +45150,7 @@ }, "put": { "summary": "Start an import", - "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", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -40719,7 +45265,7 @@ }, "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:** 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).", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -40832,7 +45378,7 @@ }, "delete": { "summary": "Cancel an import", - "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", + "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -40872,7 +45418,7 @@ "/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:** 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).", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -40933,7 +45479,7 @@ "/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:** 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", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -41028,7 +45574,7 @@ "/repos/{owner}/{repo}/import/large_files": { "get": { "summary": "Get large files", - "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", + "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -41083,7 +45629,7 @@ "/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:** 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", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -41551,7 +46097,7 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -41693,7 +46239,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -41734,7 +46280,7 @@ }, "assignee": { "type": "string", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_", "nullable": true }, "milestone": { @@ -42299,7 +46845,7 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], @@ -42465,7 +47011,7 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -42524,7 +47070,7 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -42571,7 +47117,7 @@ "assignee": { "type": "string", "nullable": true, - "description": "Username to assign to this issue. **This field is deprecated.**" + "description": "Username to assign to this issue. **This field is closing down.**" }, "state": { "type": "string", @@ -42991,7 +47537,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -43880,7 +48426,7 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], @@ -43917,17 +48463,17 @@ "x-octokit": {} } }, - "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - "get": { - "summary": "List timeline events for an issue", - "description": "List all timeline events for an issue.", + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + "delete": { + "summary": "Remove sub-issue", + "description": "You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/list-events-for-timeline", + "operationId": "issues/remove-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue" + "url": "https://docs.github.com/rest/issues/sub-issues#remove-sub-issue" }, "parameters": [ { @@ -43938,65 +48484,86 @@ }, { "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sub_issue_id": { + "type": "integer", + "description": "The sub-issue to remove" + } + }, + "required": [ + "sub_issue_id" + ] + }, + "examples": { + "default": { + "value": { + "sub_issue_id": 6 + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/timeline-issue-events" - } + "$ref": "#/components/schemas/issue" }, "examples": { "default": { - "$ref": "#/components/examples/timeline-issue-events" + "$ref": "#/components/examples/issue" } } } }, "headers": { - "Link": { - "$ref": "#/components/headers/link" + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue", + "schema": { + "type": "string" + } } } }, + "400": { + "$ref": "#/components/responses/bad_request" + }, "404": { "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "timeline" + "subcategory": "sub-issues" }, "x-octokit": {} } }, - "/repos/{owner}/{repo}/keys": { + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { "get": { - "summary": "List deploy keys", - "description": "", + "summary": "List sub-issues", + "description": "You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/list-deploy-keys", + "operationId": "issues/list-sub-issues", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys" + "url": "https://docs.github.com/rest/issues/sub-issues#list-sub-issues" }, "parameters": [ { @@ -44005,6 +48572,9 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/issue-number" + }, { "$ref": "#/components/parameters/per-page" }, @@ -44020,12 +48590,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/deploy-key" + "$ref": "#/components/schemas/issue" } }, "examples": { "default": { - "$ref": "#/components/examples/deploy-key-items" + "$ref": "#/components/examples/issue-items" } } } @@ -44035,26 +48605,32 @@ "$ref": "#/components/headers/link" } } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "sub-issues" }, "x-octokit": {} }, "post": { - "summary": "Create a deploy key", - "description": "You can create a read-only deploy key.", + "summary": "Add sub-issue", + "description": "You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/create-deploy-key", + "operationId": "issues/add-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key" + "url": "https://docs.github.com/rest/issues/sub-issues#add-sub-issue" }, "parameters": [ { @@ -44062,6 +48638,9 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" } ], "requestBody": { @@ -44071,29 +48650,23 @@ "schema": { "type": "object", "properties": { - "title": { - "type": "string", - "description": "A name for the key." - }, - "key": { - "type": "string", - "description": "The contents of the key." + "sub_issue_id": { + "type": "integer", + "description": "The sub-issue to add" }, - "read_only": { + "replace_parent": { "type": "boolean", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"" + "description": "Option that, when true, instructs the operation to replace the sub-issues current parent issue" } }, "required": [ - "key" + "sub_issue_id" ] }, "examples": { "default": { "value": { - "title": "octocat@octomac", - "key": "ssh-rsa AAA...", - "read_only": true + "sub_issue_id": 1 } } } @@ -44106,24 +48679,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deploy-key" + "$ref": "#/components/schemas/issue" }, "examples": { "default": { - "$ref": "#/components/examples/deploy-key" + "$ref": "#/components/examples/issue" } } } }, "headers": { "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1", "schema": { "type": "string" } } } }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -44131,23 +48713,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "sub-issues" }, "x-octokit": {} } }, - "/repos/{owner}/{repo}/keys/{key_id}": { - "get": { - "summary": "Get a deploy key", - "description": "", + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + "patch": { + "summary": "Reprioritize sub-issue", + "description": "You can use the REST API to reprioritize a sub-issue to a different position in the parent list.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/get-deploy-key", + "operationId": "issues/reprioritize-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key" + "url": "https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue" }, "parameters": [ { @@ -44157,47 +48739,94 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/key-id" + "$ref": "#/components/parameters/issue-number" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sub_issue_id": { + "type": "integer", + "description": "The id of the sub-issue to reprioritize" + }, + "after_id": { + "type": "integer", + "description": "The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified)." + }, + "before_id": { + "type": "integer", + "description": "The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified)." + } + }, + "required": [ + "sub_issue_id" + ] + }, + "examples": { + "default": { + "value": { + "sub_issue_id": 6, + "after_id": 5 + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deploy-key" + "$ref": "#/components/schemas/issue" }, "examples": { "default": { - "$ref": "#/components/examples/deploy-key" + "$ref": "#/components/examples/issue" } } } } }, + "403": { + "$ref": "#/components/responses/forbidden" + }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "sub-issues" }, "x-octokit": {} - }, - "delete": { - "summary": "Delete a deploy key", - "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + "get": { + "summary": "List timeline events for an issue", + "description": "List all timeline events for an issue.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/delete-deploy-key", + "operationId": "issues/list-events-for-timeline", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key" + "url": "https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue" }, "parameters": [ { @@ -44207,34 +48836,304 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/key-id" + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/timeline-issue-events" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/timeline-issue-events" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "timeline" }, "x-octokit": {} } }, - "/repos/{owner}/{repo}/labels": { + "/repos/{owner}/{repo}/keys": { "get": { - "summary": "List labels for a repository", - "description": "Lists all labels for a repository.", + "summary": "List deploy keys", + "description": "", "tags": [ - "issues" + "repos" ], - "operationId": "issues/list-labels-for-repo", + "operationId": "repos/list-deploy-keys", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/issues/labels#list-labels-for-a-repository" + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deploy-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a deploy key", + "description": "You can create a read-only deploy key.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "A name for the key." + }, + "key": { + "type": "string", + "description": "The contents of the key." + }, + "read_only": { + "type": "boolean", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"" + } + }, + "required": [ + "key" + ] + }, + "examples": { + "default": { + "value": { + "title": "octocat@octomac", + "key": "ssh-rsa AAA...", + "read_only": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deploy-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/keys/{key_id}": { + "get": { + "summary": "Get a deploy key", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/get-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deploy-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a deploy key", + "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/labels": { + "get": { + "summary": "List labels for a repository", + "description": "Lists all labels for a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#list-labels-for-a-repository" }, "parameters": [ { @@ -45637,7 +50536,7 @@ "properties": { "cname": { "type": "string", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site).\"", "nullable": true }, "https_enforced": { @@ -46827,7 +51726,7 @@ }, "post": { "summary": "Create a pull request", - "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.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -47388,7 +52287,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -47428,7 +52327,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get a pull request", - "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.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "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.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], @@ -47450,7 +52349,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -47624,7 +52523,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -47814,7 +52713,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -47855,7 +52754,7 @@ }, "position": { "type": "integer", - "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "deprecated": true, "x-github": { "deprecationDate": "2022-11-01" @@ -47967,7 +52866,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -48120,7 +53019,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -48230,7 +53129,7 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], @@ -48683,7 +53582,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -49084,7 +53983,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -49273,7 +54172,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { "put": { "summary": "Update a pull request branch", - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.", "tags": [ "pulls" ], @@ -49405,6 +54304,9 @@ } } }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "404": { "$ref": "#/components/responses/not_found" }, @@ -49556,7 +54458,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], @@ -49623,7 +54525,7 @@ "false", "legacy" ], - "default": true + "default": "true" } }, "required": [ @@ -49697,7 +54599,7 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], @@ -50061,7 +54963,7 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], @@ -50600,7 +55502,7 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], @@ -50735,6 +55637,9 @@ "type": "boolean", "default": true } + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -50804,12 +55709,13 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", "push" - ] + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -51030,7 +55936,7 @@ "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { "get": { "summary": "Get a repository ruleset", - "description": "Get a ruleset for a repository.", + "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], @@ -51145,7 +56051,7 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", @@ -51334,6 +56240,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" } ], "responses": { @@ -51590,6 +56502,146 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + "post": { + "summary": "Create a push protection bypass", + "description": "Creates a bypass for a previously push protected secret.\n\nThe authenticated user must be the original author of the committed secret.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "secret-scanning/create-push-protection-bypass", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + } + }, + "required": [ + "reason", + "placeholder_id" + ] + }, + "examples": { + "default": { + "value": { + "reason": "will_fix_later", + "placeholder_id": "2k4dM4tseyC5lPIsjl5emX9sPNk" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-push-protection-bypass" + } + } + } + } + }, + "403": { + "description": "User does not have enough permissions to perform this action." + }, + "404": { + "description": "Placeholder ID not found, or push protection is disabled on this repository." + }, + "422": { + "description": "Bad request, input data missing or incorrect." + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "secret-scanning", + "subcategory": "secret-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + "get": { + "summary": "Get secret scanning scan history for a repository", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/get-scan-history", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-scan-history" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-scan-history" + } + } + } + } + }, + "404": { + "description": "Repository does not have GitHub Advanced Security or secret scanning enabled" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/security-advisories": { "get": { "summary": "List repository security advisories", @@ -52188,7 +57240,7 @@ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { "post": { "summary": "Create a temporary private fork", - "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n**Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.", + "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n> [!NOTE]\n> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.", "tags": [ "security-advisories" ], @@ -52325,7 +57377,7 @@ "/repos/{owner}/{repo}/stats/code_frequency": { "get": { "summary": "Get the weekly commit activity", - "description": "\nReturns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n**Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains\n10,000 or more commits, a 422 status code will be returned.\n", + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n> [!NOTE]\n> This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.", "tags": [ "repos" ], @@ -52438,7 +57490,7 @@ "/repos/{owner}/{repo}/stats/contributors": { "get": { "summary": "Get all contributor commit activity", - "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n**Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.", + "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n> [!NOTE]\n> This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.", "tags": [ "repos" ], @@ -52982,15 +58034,15 @@ }, "/repos/{owner}/{repo}/tags/protection": { "get": { - "summary": "List tag protection states for a repository", - "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", + "summary": "Closing down - List tag protection states for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/list-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/tags#list-tag-protection-states-for-a-repository" + "url": "https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository" }, "parameters": [ { @@ -53030,20 +58082,23 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} }, "post": { - "summary": "Create a tag protection state for a repository", - "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Create a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/create-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/tags#create-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -53106,22 +58161,25 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { "delete": { - "summary": "Delete a tag protection state for a repository", - "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Delete a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/delete-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/tags#delete-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -53149,15 +58207,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tarball/{ref}": { "get": { "summary": "Download a repository archive (tar)", - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", "tags": [ "repos" ], @@ -53360,7 +58421,7 @@ "properties": { "names": { "type": "array", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.", "items": { "type": "string" } @@ -53817,7 +58878,7 @@ "/repos/{owner}/{repo}/zipball/{ref}": { "get": { "summary": "Download a repository archive (zip)", - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "tags": [ "repos" ], @@ -53982,7 +59043,7 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "repos", "subcategory": "repos" }, @@ -54074,7 +59135,7 @@ { "name": "sort", "deprecated": true, - "description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "description": "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -54086,7 +59147,7 @@ }, { "name": "order", - "description": "**This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ", + "description": "**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ", "in": "query", "deprecated": true, "required": false, @@ -54259,7 +59320,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], @@ -54759,7 +59820,7 @@ "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], @@ -54806,7 +59867,7 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], @@ -54853,7 +59914,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -54938,7 +59999,7 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], @@ -54978,7 +60039,7 @@ "/teams/{team_id}/discussions": { "get": { "summary": "List discussions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55039,7 +60100,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55123,7 +60184,7 @@ "/teams/{team_id}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55170,7 +60231,7 @@ }, "patch": { "summary": "Update a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55244,7 +60305,7 @@ }, "delete": { "summary": "Delete a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55281,7 +60342,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55345,7 +60406,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55421,7 +60482,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55471,7 +60532,7 @@ }, "patch": { "summary": "Update a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55547,7 +60608,7 @@ }, "delete": { "summary": "Delete a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -55587,7 +60648,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -55670,7 +60731,7 @@ }, "post": { "summary": "Create reaction for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -55758,7 +60819,7 @@ "/teams/{team_id}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -55838,7 +60899,7 @@ }, "post": { "summary": "Create reaction for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -55923,7 +60984,7 @@ "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", "tags": [ "teams" ], @@ -55983,7 +61044,7 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], @@ -56061,7 +61122,7 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], @@ -56099,7 +61160,7 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using 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.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using 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.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], @@ -56143,7 +61204,7 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], @@ -56183,7 +61244,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", "tags": [ "teams" ], @@ -56233,7 +61294,7 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], @@ -56318,7 +61379,7 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], @@ -56358,7 +61419,7 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "tags": [ "teams" ], @@ -56421,7 +61482,7 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "tags": [ "teams" ], @@ -56471,7 +61532,7 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", "tags": [ "teams" ], @@ -56567,7 +61628,7 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", "tags": [ "teams" ], @@ -56610,7 +61671,7 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], @@ -56673,7 +61734,7 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], @@ -56729,7 +61790,7 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], @@ -56802,7 +61863,7 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], @@ -56842,7 +61903,7 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], @@ -56934,7 +61995,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "response-with-public-and-private-profile-information": { @@ -57398,7 +62466,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -57470,7 +62538,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -58901,9 +63969,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 + "example": "username@example.com" }, + "minItems": 1, "example": [] } }, @@ -59013,9 +64081,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 - } + "example": "username@example.com" + }, + "minItems": 1 } }, "example": { @@ -59299,6 +64367,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -59798,7 +64869,7 @@ "/user/installations/{installation_id}/repositories/{repository_id}": { "put": { "summary": "Add a repository to an app installation", - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], @@ -59849,7 +64920,7 @@ }, "delete": { "summary": "Remove a repository from an app installation", - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], @@ -60066,7 +65137,7 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -61266,7 +66337,7 @@ "/user/orgs": { "get": { "summary": "List organizations for the authenticated user", - "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.", "tags": [ "orgs" ], @@ -61329,7 +66400,7 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -61401,7 +66472,7 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -61445,7 +66516,7 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -61488,7 +66559,7 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -61540,7 +66611,7 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -61628,7 +66699,7 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -61675,7 +66746,7 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -61721,7 +66792,7 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62178,7 +67249,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -62195,7 +67266,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -63300,6 +68371,69 @@ "x-octokit": {} } }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/rest/users/emails)\".", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + }, + "x-octokit": {} + } + }, "/users": { "get": { "summary": "List users", @@ -63390,7 +68524,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "default-response": { @@ -63416,6 +68557,108 @@ "x-octokit": {} } }, + "/users/{username}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "$ref": "#/components/schemas/sigstore-bundle-0" + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + }, + "x-octokit": {} + } + }, "/users/{username}/docker/conflicts": { "get": { "summary": "Get list of conflicting packages during Docker migration for user", @@ -63471,7 +68714,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63523,7 +68766,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63578,7 +68821,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64136,7 +69379,7 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64217,7 +69460,7 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64264,7 +69507,7 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64310,7 +69553,7 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64365,7 +69608,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by a user", - "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64426,7 +69669,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64476,7 +69719,7 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64525,7 +69768,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -64649,7 +69892,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64701,7 +69944,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -65387,6 +70630,58 @@ }, "x-octokit": {} } + }, + "/orgs/{org}/organization-fine-grained-permissions": { + "get": { + "summary": "List organization fine-grained permissions for an organization", + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-organization-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-fine-grained-permission" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-fine-grained-permission-example" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } } }, "x-webhooks": { @@ -65857,7 +71152,7 @@ }, "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { @@ -65966,7 +71261,7 @@ }, "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -66075,7 +71370,7 @@ }, "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", "operationId": "check-run/requested-action", "externalDocs": { @@ -66184,7 +71479,7 @@ }, "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", "operationId": "check-run/rerequested", "externalDocs": { @@ -66293,7 +71588,7 @@ }, "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { @@ -66386,7 +71681,7 @@ }, "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", "operationId": "check-suite/requested", "externalDocs": { @@ -66479,7 +71774,7 @@ }, "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", "operationId": "check-suite/rerequested", "externalDocs": { @@ -67399,6 +72694,7 @@ "category": "webhooks", "subcategory": "custom_property", "supported-webhook-types": [ + "business", "organization", "app" ] @@ -67491,6 +72787,7 @@ "category": "webhooks", "subcategory": "custom_property", "supported-webhook-types": [ + "business", "organization", "app" ] @@ -67583,6 +72880,7 @@ "category": "webhooks", "subcategory": "custom_property", "supported-webhook-types": [ + "business", "organization", "app" ] @@ -67684,7 +72982,7 @@ }, "delete": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", "operationId": "delete", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#delete" @@ -67776,7 +73074,7 @@ }, "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { @@ -67869,7 +73167,7 @@ }, "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", "operationId": "dependabot-alert/auto-reopened", "externalDocs": { @@ -67962,7 +73260,7 @@ }, "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", "operationId": "dependabot-alert/created", "externalDocs": { @@ -68055,7 +73353,7 @@ }, "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert was manually closed.", "operationId": "dependabot-alert/dismissed", "externalDocs": { @@ -68148,7 +73446,7 @@ }, "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A manifest file change removed a vulnerability.", "operationId": "dependabot-alert/fixed", "externalDocs": { @@ -68241,7 +73539,7 @@ }, "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", "operationId": "dependabot-alert/reintroduced", "externalDocs": { @@ -68334,7 +73632,7 @@ }, "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert was manually reopened.", "operationId": "dependabot-alert/reopened", "externalDocs": { @@ -69070,7 +74368,7 @@ }, "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", "description": "A new deployment status was created.", "operationId": "deployment-status/created", "externalDocs": { @@ -69163,7 +74461,7 @@ }, "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was marked as the answer.", "operationId": "discussion/answered", "externalDocs": { @@ -69256,7 +74554,7 @@ }, "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The category of a discussion was changed.", "operationId": "discussion/category-changed", "externalDocs": { @@ -69349,7 +74647,7 @@ }, "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was closed.", "operationId": "discussion/closed", "externalDocs": { @@ -69442,7 +74740,7 @@ }, "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was created.", "operationId": "discussion-comment/created", "externalDocs": { @@ -69535,7 +74833,7 @@ }, "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was deleted.", "operationId": "discussion-comment/deleted", "externalDocs": { @@ -69628,7 +74926,7 @@ }, "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was edited.", "operationId": "discussion-comment/edited", "externalDocs": { @@ -69721,7 +75019,7 @@ }, "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was created.", "operationId": "discussion/created", "externalDocs": { @@ -69814,7 +75112,7 @@ }, "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was deleted.", "operationId": "discussion/deleted", "externalDocs": { @@ -69907,7 +75205,7 @@ }, "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", "operationId": "discussion/edited", "externalDocs": { @@ -70000,7 +75298,7 @@ }, "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was added to a discussion.", "operationId": "discussion/labeled", "externalDocs": { @@ -70093,7 +75391,7 @@ }, "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was locked.", "operationId": "discussion/locked", "externalDocs": { @@ -70186,7 +75484,7 @@ }, "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was pinned.", "operationId": "discussion/pinned", "externalDocs": { @@ -70279,7 +75577,7 @@ }, "discussion-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was reopened.", "operationId": "discussion/reopened", "externalDocs": { @@ -70372,7 +75670,7 @@ }, "discussion-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was transferred to another repository.", "operationId": "discussion/transferred", "externalDocs": { @@ -70465,7 +75763,7 @@ }, "discussion-unanswered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was unmarked as the answer.", "operationId": "discussion/unanswered", "externalDocs": { @@ -70558,7 +75856,7 @@ }, "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was removed from a discussion.", "operationId": "discussion/unlabeled", "externalDocs": { @@ -70651,7 +75949,7 @@ }, "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unlocked.", "operationId": "discussion/unlocked", "externalDocs": { @@ -70744,7 +76042,7 @@ }, "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unpinned.", "operationId": "discussion/unpinned", "externalDocs": { @@ -76487,7 +81785,7 @@ }, "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was approved.", "operationId": "personal-access-token-request/approved", "externalDocs": { @@ -76578,7 +81876,7 @@ }, "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was cancelled by the requester.", "operationId": "personal-access-token-request/cancelled", "externalDocs": { @@ -76669,7 +81967,7 @@ }, "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was created.", "operationId": "personal-access-token-request/created", "externalDocs": { @@ -76760,7 +82058,7 @@ }, "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was denied.", "operationId": "personal-access-token-request/denied", "externalDocs": { @@ -78263,7 +83561,7 @@ }, "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was closed.", "operationId": "projects-v2/closed", "externalDocs": { @@ -78355,7 +83653,7 @@ }, "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was created.", "operationId": "projects-v2/created", "externalDocs": { @@ -78447,7 +83745,7 @@ }, "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was deleted.", "operationId": "projects-v2/deleted", "externalDocs": { @@ -78539,7 +83837,7 @@ }, "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The title, description, or README of a project in the organization was changed.", "operationId": "projects-v2/edited", "externalDocs": { @@ -78631,7 +83929,7 @@ }, "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/archived", "externalDocs": { @@ -78723,7 +84021,7 @@ }, "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A draft issue in an organization project was converted to an issue.", "operationId": "projects-v2-item/converted", "externalDocs": { @@ -78815,7 +84113,7 @@ }, "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was added to a project in the organization.", "operationId": "projects-v2-item/created", "externalDocs": { @@ -78907,7 +84205,7 @@ }, "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was deleted from a project in the organization.", "operationId": "projects-v2-item/deleted", "externalDocs": { @@ -78999,7 +84297,7 @@ }, "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", "operationId": "projects-v2-item/edited", "externalDocs": { @@ -79091,7 +84389,7 @@ }, "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", "operationId": "projects-v2-item/reordered", "externalDocs": { @@ -79183,7 +84481,7 @@ }, "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/restored", "externalDocs": { @@ -79275,7 +84573,7 @@ }, "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was reopened.", "operationId": "projects-v2/reopened", "externalDocs": { @@ -79365,12 +84663,13 @@ } } }, - "public": { + "projects-v2-status-update-created": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was added to a project in the organization.", + "operationId": "projects-v2-status-update/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -79392,7 +84691,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -79435,7 +84734,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -79447,23 +84746,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "public", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-assigned": { + "projects-v2-status-update-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was removed from a project in the organization.", + "operationId": "projects-v2-status-update/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -79485,7 +84783,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -79528,7 +84826,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -79540,23 +84838,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-disabled": { + "projects-v2-status-update-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -79578,7 +84875,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -79621,7 +84918,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" } } } @@ -79633,23 +84930,21 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-enabled": { + "public": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -79714,7 +85009,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-public" } } } @@ -79727,7 +85022,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "public", "supported-webhook-types": [ "repository", "organization", @@ -79736,11 +85031,11 @@ } } }, - "pull-request-closed": { + "pull-request-assigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -79807,7 +85102,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -79829,11 +85124,11 @@ } } }, - "pull-request-converted-to-draft": { + "pull-request-auto-merge-disabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -79900,7 +85195,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -79922,11 +85217,11 @@ } } }, - "pull-request-demilestoned": { + "pull-request-auto-merge-enabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -79993,7 +85288,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -80015,11 +85310,11 @@ } } }, - "pull-request-dequeued": { + "pull-request-closed": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from the merge queue.", - "operationId": "pull-request/dequeued", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80086,7 +85381,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -80108,11 +85403,11 @@ } } }, - "pull-request-edited": { + "pull-request-converted-to-draft": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80179,7 +85474,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -80201,11 +85496,11 @@ } } }, - "pull-request-enqueued": { + "pull-request-demilestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to the merge queue.", - "operationId": "pull-request/enqueued", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80272,7 +85567,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -80294,11 +85589,11 @@ } } }, - "pull-request-labeled": { + "pull-request-dequeued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "description": "A pull request was removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80365,7 +85660,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -80387,11 +85682,11 @@ } } }, - "pull-request-locked": { + "pull-request-edited": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80458,7 +85753,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -80480,11 +85775,11 @@ } } }, - "pull-request-milestoned": { + "pull-request-enqueued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "description": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80551,7 +85846,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -80573,11 +85868,11 @@ } } }, - "pull-request-opened": { + "pull-request-labeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80644,7 +85939,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -80666,11 +85961,11 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-locked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80737,7 +86032,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -80759,11 +86054,11 @@ } } }, - "pull-request-reopened": { + "pull-request-milestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -80830,7 +86125,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -80852,13 +86147,13 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80923,7 +86218,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -80936,7 +86231,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -80945,13 +86240,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81016,7 +86311,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -81029,7 +86324,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -81038,13 +86333,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81109,7 +86404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -81122,7 +86417,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -81131,13 +86426,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81202,7 +86497,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -81215,7 +86510,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -81224,13 +86519,13 @@ } } }, - "pull-request-review-edited": { + "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81295,7 +86590,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -81308,7 +86603,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -81317,13 +86612,13 @@ } } }, - "pull-request-review-request-removed": { + "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81388,7 +86683,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -81401,7 +86696,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -81410,13 +86705,13 @@ } } }, - "pull-request-review-requested": { + "pull-request-review-dismissed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -81481,7 +86776,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -81494,7 +86789,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -81503,11 +86798,11 @@ } } }, - "pull-request-review-submitted": { + "pull-request-review-edited": { "post": { "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, @@ -81574,7 +86869,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -81596,13 +86891,13 @@ } } }, - "pull-request-review-thread-resolved": { + "pull-request-review-request-removed": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81667,7 +86962,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -81680,7 +86975,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -81689,13 +86984,13 @@ } } }, - "pull-request-review-thread-unresolved": { + "pull-request-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81760,7 +87055,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" } } } @@ -81773,7 +87068,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -81782,13 +87077,13 @@ } } }, - "pull-request-synchronize": { + "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -81853,7 +87148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -81866,7 +87161,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -81875,13 +87170,13 @@ } } }, - "pull-request-unassigned": { + "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -81946,7 +87241,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -81959,7 +87254,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -81968,13 +87263,13 @@ } } }, - "pull-request-unlabeled": { + "pull-request-review-thread-unresolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -82039,7 +87334,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -82052,7 +87347,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -82061,11 +87356,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-synchronize": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -82132,7 +87427,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -82154,12 +87449,13 @@ } } }, - "push": { + "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82224,7 +87520,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -82237,7 +87533,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -82246,13 +87542,13 @@ } } }, - "registry-package-published": { + "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82317,7 +87613,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -82330,7 +87626,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -82339,13 +87635,13 @@ } } }, - "registry-package-updated": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82410,7 +87706,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -82423,7 +87719,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -82432,13 +87728,12 @@ } } }, - "release-created": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -82503,7 +87798,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-push" } } } @@ -82516,7 +87811,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -82525,13 +87820,13 @@ } } }, - "release-deleted": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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 release was deleted.", - "operationId": "release/deleted", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -82596,7 +87891,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -82609,7 +87904,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -82618,13 +87913,13 @@ } } }, - "release-edited": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -82689,7 +87984,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -82702,7 +87997,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -82711,11 +88006,11 @@ } } }, - "release-prereleased": { + "release-created": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -82782,7 +88077,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -82804,11 +88099,11 @@ } } }, - "release-published": { + "release-deleted": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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, pre-release, or draft release was deleted.", + "operationId": "release/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -82875,7 +88170,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -82897,11 +88192,11 @@ } } }, - "release-released": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -82968,7 +88263,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -82990,11 +88285,11 @@ } } }, - "release-unpublished": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/webhooks/webhook-events-and-payloads#release" }, @@ -83061,7 +88356,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -83083,13 +88378,13 @@ } } }, - "repository-advisory-published": { + "release-published": { "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/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", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83154,7 +88449,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -83167,7 +88462,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -83176,13 +88471,13 @@ } } }, - "repository-advisory-reported": { + "release-released": { "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/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 releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83247,7 +88542,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -83260,7 +88555,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -83269,13 +88564,13 @@ } } }, - "repository-archived": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83340,7 +88635,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -83353,9 +88648,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83363,13 +88657,13 @@ } } }, - "repository-created": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "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/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/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -83434,7 +88728,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -83447,9 +88741,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83457,13 +88750,13 @@ } } }, - "repository-deleted": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -83528,7 +88821,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -83541,9 +88834,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83551,12 +88843,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-archived": { "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/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -83621,7 +88914,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -83634,18 +88927,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "repository-created": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -83712,7 +89008,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -83735,12 +89031,13 @@ } } }, - "repository-import": { + "repository-deleted": { "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/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/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/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -83805,7 +89102,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -83818,21 +89115,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "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/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -83897,7 +89195,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -83910,21 +89208,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-publicized": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -83991,7 +89286,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -84014,11 +89309,102 @@ } } }, - "repository-renamed": { + "repository-import": { + "post": { + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/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/rest/migrations/source-imports).", + "operationId": "repository-import", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + }, + "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-import" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_import", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -84085,7 +89471,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -84108,13 +89494,13 @@ } } }, - "repository-ruleset-created": { + "repository-publicized": { "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 or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84179,7 +89565,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -84192,8 +89578,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -84201,13 +89588,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-renamed": { "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 or organization 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/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84272,7 +89659,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -84285,8 +89672,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -84294,11 +89682,11 @@ } } }, - "repository-ruleset-edited": { + "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 or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -84365,7 +89753,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -84387,13 +89775,13 @@ } } }, - "repository-transferred": { + "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/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -84458,7 +89846,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -84471,9 +89859,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -84481,13 +89868,13 @@ } } }, - "repository-unarchived": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -84552,7 +89939,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -84565,9 +89952,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -84575,13 +89961,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-transferred": { "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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84646,7 +90032,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -84659,21 +90045,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-unarchived": { "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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84738,7 +90126,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -84751,19 +90139,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-create": { "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 security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -84830,7 +90220,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -84851,11 +90241,11 @@ } } }, - "repository-vulnerability-alert-resolve": { + "repository-vulnerability-alert-dismiss": { "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 a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -84922,7 +90312,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -84943,13 +90333,13 @@ } } }, - "secret-scanning-alert-created": { + "repository-vulnerability-alert-reopen": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85014,7 +90404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -85027,22 +90417,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-location-created": { + "repository-vulnerability-alert-resolve": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85107,22 +90496,99 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } - }, - "application/x-www-form-urlencoded": { + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-created": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "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-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-created" } } } @@ -85134,9 +90600,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -85145,13 +90610,13 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-location-created": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -85216,7 +90681,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$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" + } } } } @@ -85228,8 +90708,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -85238,11 +90719,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-publicly-leaked": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -85309,7 +90790,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -85331,11 +90812,11 @@ } } }, - "secret-scanning-alert-revoked": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -85402,7 +90883,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -85424,11 +90905,11 @@ } } }, - "secret-scanning-alert-validated": { + "secret-scanning-alert-resolved": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 validated.", - "operationId": "secret-scanning-alert/validated", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -85495,7 +90976,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -85517,13 +90998,13 @@ } } }, - "security-advisory-published": { + "secret-scanning-alert-validated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/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/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -85588,7 +91069,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -85601,20 +91082,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "secret-scanning-scan-completed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/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/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\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 scan was completed.", + "operationId": "secret-scanning-scan/completed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { @@ -85679,7 +91162,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -85692,18 +91175,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "security-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/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/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -85770,7 +91255,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -85790,12 +91275,13 @@ } } }, - "security-and-analysis": { + "security-advisory-updated": { "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/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 global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/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/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -85860,7 +91346,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -85873,22 +91359,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "sponsorship-cancelled": { + "security-advisory-withdrawn": { "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/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/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/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", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/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/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -85953,7 +91437,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -85966,20 +91450,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_advisory", "supported-webhook-types": [ - "sponsors_listing" + "app" ] } } }, - "sponsorship-created": { + "security-and-analysis": { "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/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/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/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", + "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/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/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -86044,7 +91527,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -86057,18 +91540,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "security_and_analysis", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "sponsorship-cancelled": { "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/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/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/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 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/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -86135,7 +91620,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -86155,11 +91640,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-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/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/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/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 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/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -86226,7 +91711,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -86246,11 +91731,11 @@ } } }, - "sponsorship-pending-tier-change": { + "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/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/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/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", + "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/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -86317,7 +91802,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -86337,11 +91822,11 @@ } } }, - "sponsorship-tier-changed": { + "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/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/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/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", + "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/webhooks/webhook-events-and-payloads#sponsorship" }, @@ -86408,7 +91893,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -86428,13 +91913,13 @@ } } }, - "star-created": { + "sponsorship-pending-tier-change": { "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/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/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/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 there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/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/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/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -86499,7 +91984,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -86512,22 +91997,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "star-deleted": { + "sponsorship-tier-changed": { "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/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/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/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 there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/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/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/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -86592,7 +92075,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -86605,21 +92088,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "status": { + "star-created": { "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/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/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/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 repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/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/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/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/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -86684,7 +92166,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -86697,7 +92179,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -86706,12 +92188,13 @@ } } }, - "team-add": { + "star-deleted": { "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/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 repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/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/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/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/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -86776,7 +92259,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -86789,7 +92272,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "star", "supported-webhook-types": [ "repository", "organization", @@ -86798,13 +92281,12 @@ } } }, - "team-added-to-repository": { + "status": { "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/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", + "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/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/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/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/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -86869,7 +92351,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-status" } } } @@ -86882,22 +92364,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "status", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "sub-issues-parent-issue-added": { "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/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", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -86962,7 +92444,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } @@ -86975,22 +92457,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "sub-issues-parent-issue-removed": { "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/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", + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -87055,7 +92537,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } @@ -87068,22 +92550,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-edited": { + "sub-issues-sub-issue-added": { "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/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 sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -87148,7 +92630,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } @@ -87161,22 +92643,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-removed-from-repository": { + "sub-issues-sub-issue-removed": { "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/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 sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { @@ -87241,7 +92723,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } @@ -87254,22 +92736,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "sub-issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "watch-started": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" 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 started watching the repository.", - "operationId": "watch/started", + "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/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/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -87334,7 +92815,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -87347,7 +92828,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "team_add", "supported-webhook-types": [ "repository", "organization", @@ -87356,12 +92837,13 @@ } } }, - "workflow-dispatch": { + "team-added-to-repository": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/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/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -87426,7 +92908,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -87439,20 +92921,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_dispatch", + "subcategory": "team", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "workflow-job-completed": { + "team-created": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/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/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -87517,7 +93001,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -87530,23 +93014,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "team", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "workflow-job-in-progress": { + "team-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -87611,7 +93094,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -87624,23 +93107,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "team", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "workflow-job-queued": { + "team-edited": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created.", - "operationId": "workflow-job/queued", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -87705,7 +93187,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-queued" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -87718,23 +93200,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "team", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "workflow-job-waiting": { + "team-removed-from-repository": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created and is waiting for approvals.", - "operationId": "workflow-job/waiting", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -87799,7 +93280,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-waiting" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -87812,23 +93293,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "team", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "workflow-run-completed": { + "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", - "operationId": "workflow-run/completed", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" 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 started watching the repository.", + "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -87893,7 +93373,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-completed" + "$ref": "#/components/schemas/webhook-watch-started" } } } @@ -87906,9 +93386,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "watch", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -87916,13 +93395,12 @@ } } }, - "workflow-run-in-progress": { + "workflow-dispatch": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run started processing on a runner.", - "operationId": "workflow-run/in-progress", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -87987,7 +93465,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-in-progress" + "$ref": "#/components/schemas/webhook-workflow-dispatch" } } } @@ -88000,23 +93478,584 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "workflow_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "workflow-run-requested": { + "workflow-job-completed": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run was triggered.", - "operationId": "workflow-run/requested", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-queued": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created.", + "operationId": "workflow-job/queued", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-queued" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-waiting": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created and is waiting for approvals.", + "operationId": "workflow-job/waiting", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-waiting" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", + "operationId": "workflow-run/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + }, + "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-workflow-run-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run started processing on a runner.", + "operationId": "workflow-run/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + }, + "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-workflow-run-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run was triggered.", + "operationId": "workflow-run/requested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -88347,6 +94386,58 @@ "vulnerable_functions" ] }, + "cvss-severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, "simple-user": { "title": "Simple User", "description": "A GitHub user.", @@ -88366,6 +94457,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -88443,6 +94535,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -88651,6 +94747,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "nullable": true, @@ -88673,6 +94772,18 @@ ] } }, + "epss": { + "type": "object", + "nullable": true, + "properties": { + "percentage": { + "type": "number" + }, + "percentile": { + "type": "number" + } + } + }, "credits": { "type": "array", "description": "The users who contributed to the advisory.", @@ -88781,6 +94892,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -88858,6 +94970,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -88902,6 +95018,10 @@ "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, "owner": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -88979,10 +95099,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -89121,6 +95237,13 @@ "type": "integer", "example": 123, "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true } }, "required": [ @@ -89295,6 +95418,13 @@ "example": 123, "nullable": true }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + }, "url": { "description": "The URL target of the delivery.", "type": "string", @@ -89699,7 +95829,7 @@ }, "organization_copilot_seat_management": { "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] @@ -89752,7 +95882,7 @@ }, "organization_projects": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", @@ -90042,7 +96172,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -90443,7 +96574,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -90699,7 +96830,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -91380,404 +97512,269 @@ "name" ] }, - "copilot-usage-metrics": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", + "code-security-configuration": { "type": "object", + "description": "A code security configuration", "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { + "id": { "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." + "description": "The ID of the code security configuration" }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + "description": { + "type": "string", + "description": "A description of the code security configuration" }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ] }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "breakdown": { - "type": "array", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." } } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - }, - "alert-number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "dependabot-alert-package": { - "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true }, - "name": { + "dependabot_alerts": { "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, - "required": [ - "ecosystem", - "name" - ], - "additionalProperties": false - }, - "dependabot-alert-security-vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, - "properties": { - "package": { - "$ref": "#/components/schemas/dependabot-alert-package" + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "severity": { + "dependabot_security_updates": { "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, + "description": "The enablement status of Dependabot security updates", "enum": [ - "low", - "medium", - "high", - "critical" + "enabled", + "disabled", + "not_set" ] }, - "vulnerable_version_range": { + "code_scanning_default_setup": { "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "first_patched_version": { + "code_scanning_default_setup_options": { "type": "object", - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, + "description": "Feature options for code scanning default setup", "nullable": true, "properties": { - "identifier": { + "runner_type": { + "nullable": true, "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } - }, - "required": [ - "identifier" - ], - "additionalProperties": false - } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false - }, - "dependabot-alert-security-advisory": { - "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, - "properties": { - "ghsa_id": { - "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true + } }, - "cve_id": { + "secret_scanning": { "type": "string", - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true, - "nullable": true + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "summary": { + "secret_scanning_push_protection": { "type": "string", - "description": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "description": { + "secret_scanning_delegated_bypass": { "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } } }, - "severity": { + "secret_scanning_validity_checks": { "type": "string", - "description": "The severity of the advisory.", - "readOnly": true, + "description": "The enablement status of secret scanning validity checks", "enum": [ - "low", - "medium", - "high", - "critical" + "enabled", + "disabled", + "not_set" ] }, - "cvss": { - "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, - "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true - }, - "vector_string": { - "type": "string", - "description": "The full CVSS vector string for the advisory.", - "readOnly": true, - "nullable": true - } - }, - "required": [ - "score", - "vector_string" - ], - "additionalProperties": false + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" }, - "published_at": { + "html_url": { "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "uri", + "description": "The URL of the configuration" }, - "updated_at": { + "created_at": { "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "format": "date-time" }, - "withdrawn_at": { + "updated_at": { "type": "string", - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true + "format": "date-time" } - }, - "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "alert-url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "alert-html-url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "alert-created-at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "alert-updated-at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "alert-dismissed-at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true + } }, - "alert-fixed-at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true + "code-scanning-default-setup-options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } }, - "alert-auto-dismissed-at": { - "type": "string", - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true + "code-security-default-configurations": { + "type": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + } }, "simple-repository": { "title": "Simple Repository", @@ -91786,6 +97783,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, @@ -92076,6 +98074,342 @@ "url" ] }, + "code-security-configuration-repositories": { + "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + } + } + }, + "alert-number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "dependabot-alert-package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "dependabot-alert-security-vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "$ref": "#/components/schemas/dependabot-alert-package" + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": "object", + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "nullable": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "dependabot-alert-security-advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": "string", + "description": "The full CVSS vector string for the advisory.", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": "string", + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "alert-url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "alert-html-url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "alert-created-at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "alert-updated-at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "alert-dismissed-at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "alert-fixed-at": { + "type": "string", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "alert-auto-dismissed-at": { + "type": "string", + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, "dependabot-alert-with-repository": { "type": "object", "description": "A Dependabot alert.", @@ -92260,7 +98594,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -92283,6 +98617,25 @@ "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, "resolution_comment": { "type": "string", "description": "The comment that was optionally added when this alert was closed", @@ -92296,6 +98649,16 @@ "inactive", "unknown" ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true } } }, @@ -92461,6 +98824,10 @@ "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, "owner": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -92538,10 +98905,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -92635,6 +98998,26 @@ "rocket" ] }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -92851,6 +99234,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -93222,6 +99608,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -93244,6 +99635,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -93294,7 +99688,11 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" }, "node_id": { "type": "string" @@ -93374,6 +99772,11 @@ "format": "email", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -93429,11 +99832,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "private_gists": { "type": "integer", "example": 1 @@ -93643,6 +100041,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -93734,6 +100135,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -93754,6 +100160,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": "string", "nullable": true @@ -94313,6 +100722,24 @@ "192.0.2.1" ] }, + "actions_macos": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "codespaces": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, "dependabot": { "type": "array", "items": { @@ -94322,6 +100749,15 @@ "192.0.2.1" ] }, + "copilot": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, "domains": { "type": "object", "properties": { @@ -94369,6 +100805,49 @@ "example.com" ] } + }, + "actions_inbound": { + "type": "object", + "properties": { + "full_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "wildcard_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + }, + "artifact_attestations": { + "type": "object", + "properties": { + "trust_domain": { + "type": "string", + "example": [ + "example" + ] + }, + "services": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } } } } @@ -94430,6 +100909,30 @@ ] } } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } }, @@ -94440,6 +100943,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -95050,6 +101554,75 @@ "description" ] }, + "billing-usage-report": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + }, "organization-full": { "title": "Organization Full", "description": "Organization Full", @@ -95192,7 +101765,8 @@ "collaborators": { "type": "integer", "example": 8, - "nullable": true + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", @@ -95279,32 +101853,38 @@ "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -95330,6 +101910,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -95482,7 +102067,7 @@ }, "patterns_allowed": { "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n**Note**: The `patterns_allowed` setting only applies to public repositories.", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", "items": { "type": "string" } @@ -95527,6 +102112,70 @@ } } }, + "runner-groups-org": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, "runner-label": { "title": "Self hosted runner label", "description": "A label for a self hosted runner", @@ -95851,6 +102500,7 @@ "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", + "nullable": true, "enum": [ "open", "dismissed", @@ -95862,7 +102512,6 @@ "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "nullable": true, "enum": [ - null, "false positive", "won't fix", "used in tests" @@ -95886,14 +102535,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "nullable": true, "type": "string", @@ -95919,6 +102560,28 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "nullable": true, + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "nullable": true, + "type": "string", + "description": "A link to the documentation for the rule used to detect the alert." } } }, @@ -96166,6 +102829,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "name": { @@ -96523,8 +103187,8 @@ } }, "copilot-organization-details": { - "title": "Copilot Business Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business subscription.", + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", "properties": { "seat_breakdown": { @@ -96576,6 +103240,15 @@ "disabled", "unconfigured" ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] } }, "required": [ @@ -96585,6 +103258,80 @@ ], "additionalProperties": true }, + "nullable-organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, "nullable-team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -96760,110 +103507,40 @@ "parent" ] }, - "organization": { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "type": "object", "properties": { - "login": { - "description": "Unique login name of the organization", - "example": "new-org", - "type": "string" - }, - "url": { - "description": "URL for the organization", - "example": "https://api.github.com/orgs/github", - "type": "string", - "format": "uri" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, - "node_id": { + "name": { "type": "string" }, - "repos_url": { - "type": "string", - "format": "uri" + "slug": { + "type": "string" }, - "events_url": { + "url": { "type": "string", "format": "uri" }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { + "sync_to_organizations": { "type": "string", - "nullable": true + "example": "disabled | all" }, - "blog": { - "description": "Display blog url for the organization", - "example": "blog.example-org.com", + "group_id": { + "nullable": true, "type": "string", - "format": "uri" + "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, "html_url": { "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "example": "New Org", - "type": "string" - }, - "company": { - "description": "Display company name for the organization", - "example": "Acme corporation", - "type": "string" - }, - "location": { - "description": "Display location for the organization", - "example": "Berlin, Germany", - "type": "string" - }, - "email": { - "description": "Display email for the organization", - "example": "org@example.com", - "type": "string", - "format": "email" - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" }, - "type": { + "members_url": { "type": "string" }, "created_at": { @@ -96873,49 +103550,16 @@ "updated_at": { "type": "string", "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } } }, "required": [ - "login", - "url", "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", + "url", "members_url", - "public_members_url", - "avatar_url", - "description", + "sync_to_organizations", + "name", "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", + "slug", "created_at", "updated_at" ] @@ -96926,26 +103570,19 @@ "type": "object", "properties": { "assignee": { - "type": "object", - "description": "The assignee that has been granted access to GitHub Copilot.", - "additionalProperties": true, - "oneOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/team" - }, - { - "$ref": "#/components/schemas/organization" - } - ] + "$ref": "#/components/schemas/simple-user" + }, + "organization": { + "$ref": "#/components/schemas/nullable-organization-simple" }, "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", "oneOf": [ { "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" } ], "nullable": true @@ -96975,7 +103612,17 @@ "updated_at": { "type": "string", "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] } }, "required": [ @@ -96984,6 +103631,407 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": "object", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, + "copilot-usage-metrics": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "type": "object", + "properties": { + "day": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." + }, + "total_suggestions_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions shown to users." + }, + "total_acceptances_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions accepted by users." + }, + "total_lines_suggested": { + "type": "integer", + "description": "The total number of lines of code completions suggested by Copilot." + }, + "total_lines_accepted": { + "type": "integer", + "description": "The total number of lines of code completions accepted by users." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + }, + "total_chat_acceptances": { + "type": "integer", + "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + }, + "total_chat_turns": { + "type": "integer", + "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + }, + "total_active_chat_users": { + "type": "integer", + "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + }, + "breakdown": { + "type": "array", + "description": "Breakdown of Copilot code completions usage by language and editor", + "nullable": true, + "items": { + "type": "object", + "description": "Breakdown of Copilot usage by editor for this language", + "additionalProperties": true, + "properties": { + "language": { + "type": "string", + "description": "The language in which Copilot suggestions were shown to users in the specified editor." + }, + "editor": { + "type": "string", + "description": "The editor in which Copilot suggestions were shown to users for the specified language." + }, + "suggestions_count": { + "type": "integer", + "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." + }, + "acceptances_count": { + "type": "integer", + "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." + }, + "lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." + }, + "lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted by users in the editor specified during the day specified." + }, + "active_users": { + "type": "integer", + "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." + } + } + } + } + }, + "required": [ + "day", + "breakdown" + ], + "additionalProperties": false + }, "organization-dependabot-secret": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", @@ -97052,6 +104100,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -97558,7 +104607,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string", @@ -97703,6 +104753,155 @@ "updated_at" ] }, + "api-insights-route-stats": { + "title": "Route Stats", + "description": "API Insights usage route stats for an actor", + "type": "array", + "items": { + "type": "object", + "properties": { + "http_method": { + "description": "The HTTP method", + "type": "string" + }, + "api_route": { + "description": "The API path's route template", + "type": "string" + }, + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "api-insights-subject-stats": { + "title": "Subject Stats", + "description": "API Insights usage subject stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "subject_type": { + "type": "string" + }, + "subject_name": { + "type": "string" + }, + "subject_id": { + "type": "integer", + "format": "int64" + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "api-insights-summary-stats": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "api-insights-time-stats": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "total_request_count": { + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "api-insights-user-stats": { + "title": "User Stats", + "description": "API Insights usage stats for a user", + "type": "array", + "items": { + "type": "object", + "properties": { + "actor_type": { + "type": "string" + }, + "actor_name": { + "type": "string" + }, + "actor_id": { + "type": "integer", + "format": "int64" + }, + "integration_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "oauth_application_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, "interaction-group": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", @@ -97833,6 +105032,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 79 }, "owner": { @@ -97925,23 +105125,6 @@ "updated_at" ] }, - "organization-fine-grained-permission": { - "title": "Organization Fine-Grained Permission", - "description": "A fine-grained permission that protects organization resources.", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - }, - "required": [ - "name", - "description" - ] - }, "organization-role": { "title": "Organization Role", "description": "Organization roles", @@ -97949,7 +105132,8 @@ "properties": { "id": { "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The name of the role.", @@ -97960,6 +105144,28 @@ "type": "string", "nullable": true }, + "base_role": { + "type": "string", + "nullable": true, + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin" + ] + }, + "source": { + "type": "string", + "nullable": true, + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined" + ] + }, "permissions": { "description": "A list of permissions included in this role.", "type": "array", @@ -97990,6 +105196,330 @@ "updated_at" ] }, + "team-role-assignment": { + "title": "A Role Assignment for a Team", + "description": "The Relationship a Team has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + }, + "user-role-assignment": { + "title": "A Role Assignment for a User", + "description": "The Relationship a User has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "inherited_from": { + "description": "Team the user has gotten the role through", + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "package-version": { "title": "Package Version", "description": "A version of a software package", @@ -98158,6 +105688,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -98181,6 +105719,8 @@ "repositories_url", "permissions", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -98193,7 +105733,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." }, "owner": { "$ref": "#/components/schemas/simple-user" @@ -98239,6 +105779,14 @@ "type": "string", "description": "Date and time when the fine-grained personal access token was approved to access the organization." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -98261,11 +105809,117 @@ "repositories_url", "permissions", "access_granted_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" ] }, + "org-private-registry-configuration": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "example": "monalisa", + "type": "string", + "nullable": true + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, + "org-private-registry-configuration-with-selected-repositories": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "example": "monalisa", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, "project": { "title": "Project", "description": "Projects are a way to organize columns and cards of work.", @@ -98363,7 +106017,7 @@ "updated_at" ] }, - "org-custom-property": { + "custom-property": { "title": "Organization Custom Property", "description": "Custom property defined on an organization", "type": "object", @@ -98372,12 +106026,28 @@ "type": "string", "description": "The name of the property" }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, "value_type": { "type": "string", "example": "single_select", "enum": [ "string", - "single_select" + "single_select", + "multi_select", + "true_false" ], "description": "The type of the value for the property" }, @@ -98431,6 +106101,61 @@ "value_type" ] }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "value_type" + ] + }, "custom-property-value": { "title": "Custom Property Value", "description": "Custom property name and associated value", @@ -98501,7 +106226,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -98902,7 +106628,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -99089,6 +106815,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -99655,14 +107382,13 @@ "type": "object", "description": "An actor that can bypass rules in a ruleset", "required": [ - "actor_type", - "bypass_mode" + "actor_type" ], "properties": { "actor_id": { "type": "integer", "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "type": "string", @@ -99673,15 +107399,16 @@ "Team", "DeployKey" ], - "description": "The type of actor that can bypass a ruleset.\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\n", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", "enum": [ "always", "pull_request" - ] + ], + "default": "always" } } }, @@ -99781,6 +107508,14 @@ "items": { "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ @@ -99820,7 +107555,7 @@ "org-ruleset-conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\n", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -99939,6 +107674,83 @@ } } }, + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, "repository-rule-required-deployments": { "title": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", @@ -99986,6 +107798,33 @@ } } }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { + "type": "string", + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", @@ -100003,6 +107842,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -100071,6 +107917,10 @@ "parameters": { "type": "object", "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, "required_status_checks": { "type": "array", "description": "Status checks that are required.", @@ -100403,6 +108253,10 @@ "parameters": { "type": "object", "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, "workflows": { "type": "array", "description": "Workflows that must pass for this rule to pass.", @@ -100454,6 +108308,37 @@ "tool" ] }, + "repository-rule-code-scanning": { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -100471,6 +108356,9 @@ { "$ref": "#/components/schemas/repository-rule-required-linear-history" }, + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, { "$ref": "#/components/schemas/repository-rule-required-deployments" }, @@ -100503,7 +108391,7 @@ }, { "title": "file_path_restriction", - "description": "Note: file_path_restriction is in beta and subject to change.\n\nPrevent commits that include changes in specified file paths from being pushed to the commit graph.", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -100534,7 +108422,7 @@ }, { "title": "max_file_path_length", - "description": "Note: max_file_path_length is in beta and subject to change.\n\nPrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -100564,7 +108452,7 @@ }, { "title": "file_extension_restriction", - "description": "Note: file_extension_restriction is in beta and subject to change.\n\nPrevent commits that include files with specified file extensions from being pushed to the commit graph.", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -100595,7 +108483,7 @@ }, { "title": "max_file_size", - "description": "Note: max_file_size is in beta and subject to change.\n\nPrevent commits that exceed a specified file size limit from being pushed to the commit.", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", "type": "object", "required": [ "type" @@ -100625,6 +108513,9 @@ }, { "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-code-scanning" } ] }, @@ -100649,11 +108540,12 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -100661,7 +108553,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -100704,6 +108597,7 @@ }, "html": { "type": "object", + "nullable": true, "properties": { "href": { "type": "string", @@ -100797,7 +108691,8 @@ "type": "string", "enum": [ "pass", - "fail" + "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`." } @@ -100859,11 +108754,13 @@ }, "evaluation_result": { "type": "string", + "nullable": true, "enum": [ "pass", - "fail" + "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`." + "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`. Null if no rules with `evaluate` enforcement status were run." }, "rule_evaluations": { "type": "array", @@ -100913,7 +108810,8 @@ }, "details": { "type": "string", - "description": "Any associated details with the rule evaluation." + "nullable": true, + "description": "The detailed failure message for the rule. Null if the rule passed." } } } @@ -101181,6 +109079,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "nullable": true, @@ -101293,89 +109194,6 @@ ], "additionalProperties": false }, - "team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - }, "actions-billing-usage": { "type": "object", "properties": { @@ -102772,7 +110590,8 @@ "id": { "description": "The project card's ID", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -102969,6 +110788,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -103498,7 +111320,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -103519,7 +111342,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -103554,7 +111378,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -104006,8 +111831,9 @@ "properties": { "id": { "description": "The id of the environment.", - "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 56780428 }, "node_id": { "type": "string", @@ -104088,8 +111914,9 @@ }, "id": { "description": "Unique identifier of the deployment", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 42 }, "node_id": { "type": "string", @@ -104731,7 +112558,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -104780,6 +112608,9 @@ }, "site_admin": { "type": "boolean" + }, + "user_view_type": { + "type": "string" } } } @@ -104929,12 +112760,19 @@ "site_admin": { "type": "boolean", "example": false + }, + "user_view_type": { + "type": "string", + "example": "public" } } }, "name": { "type": "string" }, + "client_id": { + "type": "string" + }, "description": { "type": "string" }, @@ -105176,6 +113014,10 @@ "signature": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -105341,10 +113183,26 @@ ] }, "author": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "committer": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "parents": { "type": "array", @@ -105839,7 +113697,8 @@ "id": { "description": "The id of the check.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "head_sha": { "description": "The SHA of the commit that is being checked.", @@ -106139,7 +113998,8 @@ "properties": { "id": { "type": "integer", - "example": 5 + "example": 5, + "format": "int64" }, "node_id": { "type": "string", @@ -106401,7 +114261,7 @@ }, "full_description": { "type": "string", - "description": "description of the rule used to detect the alert." + "description": "A description of the rule used to detect the alert." }, "tags": { "nullable": true, @@ -106495,6 +114355,74 @@ "dismissed" ] }, + "code-scanning-autofix-status": { + "type": "string", + "description": "The status of an autofix.", + "enum": [ + "pending", + "error", + "success", + "outdated" + ] + }, + "code-scanning-autofix-description": { + "type": "string", + "description": "The description of an autofix.", + "nullable": true + }, + "code-scanning-autofix-started-at": { + "type": "string", + "description": "The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "code-scanning-autofix": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/code-scanning-autofix-status" + }, + "description": { + "$ref": "#/components/schemas/code-scanning-autofix-description" + }, + "started_at": { + "$ref": "#/components/schemas/code-scanning-autofix-started-at" + } + }, + "required": [ + "status", + "description", + "started_at" + ] + }, + "code-scanning-autofix-commits": { + "description": "Commit an autofix for a code scanning alert", + "type": "object", + "properties": { + "target_ref": { + "description": "The Git reference of target branch for the commit. Branch needs to already exist. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "type": "string" + }, + "message": { + "description": "Commit message to be used.", + "type": "string" + } + }, + "nullable": true + }, + "code-scanning-autofix-commits-response": { + "type": "object", + "properties": { + "target_ref": { + "type": "string", + "description": "The Git reference of target branch for the commit. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." + }, + "sha": { + "type": "string", + "description": "SHA of commit with autofix." + } + } + }, "code-scanning-analysis-sarif-id": { "type": "string", "description": "An identifier for the upload.", @@ -106681,6 +114609,278 @@ "url" ] }, + "code-scanning-variant-analysis-language": { + "type": "string", + "description": "The language targeted by the CodeQL query", + "enum": [ + "cpp", + "csharp", + "go", + "java", + "javascript", + "python", + "ruby", + "swift" + ] + }, + "code-scanning-variant-analysis-repository": { + "title": "Repository Identifier", + "description": "Repository Identifier", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + } + }, + "required": [ + "full_name", + "id", + "name", + "private", + "stargazers_count", + "updated_at" + ] + }, + "code-scanning-variant-analysis-status": { + "type": "string", + "description": "The new status of the CodeQL variant analysis repository task.", + "enum": [ + "pending", + "in_progress", + "succeeded", + "failed", + "canceled", + "timed_out" + ] + }, + "code-scanning-variant-analysis-skipped-repo-group": { + "type": "object", + "properties": { + "repository_count": { + "type": "integer", + "description": "The total number of repositories that were skipped for this reason.", + "example": 2 + }, + "repositories": { + "type": "array", + "description": "A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it.", + "items": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" + } + } + }, + "required": [ + "repository_count", + "repositories" + ] + }, + "code-scanning-variant-analysis": { + "title": "Variant Analysis", + "description": "A run of a CodeQL query against one or more repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the variant analysis." + }, + "controller_repo": { + "$ref": "#/components/schemas/simple-repository" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "query_language": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-language" + }, + "query_pack_url": { + "type": "string", + "description": "The download url for the query pack." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "completed_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "succeeded", + "failed", + "cancelled" + ] + }, + "actions_workflow_run_id": { + "type": "integer", + "description": "The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started." + }, + "failure_reason": { + "type": "string", + "enum": [ + "no_repos_queried", + "actions_workflow_run_failed", + "internal_error" + ], + "description": "The reason for a failure of the variant analysis. This is only available if the variant analysis has failed." + }, + "scanned_repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "repository": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" + }, + "analysis_status": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-status" + }, + "result_count": { + "type": "integer", + "description": "The number of results in the case of a successful analysis. This is only available for successful analyses." + }, + "artifact_size_in_bytes": { + "type": "integer", + "description": "The size of the artifact. This is only available for successful analyses." + }, + "failure_message": { + "type": "string", + "description": "The reason of the failure of this repo task. This is only available if the repository task has failed." + } + }, + "required": [ + "repository", + "analysis_status" + ] + } + }, + "skipped_repositories": { + "type": "object", + "description": "Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis.", + "properties": { + "access_mismatch_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + }, + "not_found_repos": { + "type": "object", + "properties": { + "repository_count": { + "type": "integer", + "description": "The total number of repositories that were skipped for this reason.", + "example": 2 + }, + "repository_full_names": { + "type": "array", + "description": "A list of full repository names that were skipped. This list may not include all repositories that were skipped.", + "items": { + "type": "string" + } + } + }, + "required": [ + "repository_count", + "repository_full_names" + ] + }, + "no_codeql_db_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + }, + "over_limit_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + } + }, + "required": [ + "access_mismatch_repos", + "not_found_repos", + "no_codeql_db_repos", + "over_limit_repos" + ] + } + }, + "required": [ + "id", + "controller_repo", + "actor", + "query_language", + "query_pack_url", + "status" + ] + }, + "code-scanning-variant-analysis-repo-task": { + "type": "object", + "properties": { + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "analysis_status": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-status" + }, + "artifact_size_in_bytes": { + "type": "integer", + "description": "The size of the artifact. This is only available for successful analyses." + }, + "result_count": { + "type": "integer", + "description": "The number of results in the case of a successful analysis. This is only available for successful analyses." + }, + "failure_message": { + "type": "string", + "description": "The reason of the failure of this repo task. This is only available if the repository task has failed." + }, + "database_commit_sha": { + "type": "string", + "description": "The SHA of the commit the CodeQL database was built against. This is only available for successful analyses." + }, + "source_location_prefix": { + "type": "string", + "description": "The source location prefix to use. This is only available for successful analyses." + }, + "artifact_url": { + "type": "string", + "description": "The URL of the artifact. This is only available for successful analyses." + } + }, + "required": [ + "repository", + "analysis_status" + ] + }, "code-scanning-default-setup": { "description": "Configuration for code scanning default setup.", "type": "object", @@ -106699,6 +114899,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -106712,6 +114913,21 @@ ] } }, + "runner_type": { + "description": "Runner type to be used.", + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled" + ] + }, + "runner_label": { + "description": "Runner label to be used if the runner type is labeled.", + "nullable": true, + "type": "string", + "example": "code-scanning" + }, "query_suite": { "description": "CodeQL query suite to be used.", "type": "string", @@ -106749,6 +114965,20 @@ "not-configured" ] }, + "runner_type": { + "description": "Runner type to be used.", + "type": "string", + "enum": [ + "standard", + "labeled" + ] + }, + "runner_label": { + "nullable": true, + "description": "Runner label to be used if the runner type is labeled.", + "type": "string", + "example": "code-scanning" + }, "query_suite": { "description": "CodeQL query suite to be used.", "type": "string", @@ -106763,6 +114993,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -106845,6 +115076,29 @@ } } }, + "code-security-configuration-for-repository": { + "type": "object", + "description": "Code security configuration associated with a repository and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, "codeowners-errors": { "title": "CODEOWNERS errors", "description": "A list of errors found in a repo's CODEOWNERS file", @@ -107014,6 +115268,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -107124,6 +115379,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -107156,7 +115415,8 @@ "id": { "description": "Unique identifier of the repository invitation.", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "repository": { "$ref": "#/components/schemas/minimal-repository" @@ -107224,6 +115484,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -107334,6 +115595,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -107544,6 +115809,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -108244,6 +116510,9 @@ "sha": { "type": "string" }, + "content": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -108280,9 +116549,6 @@ "path": { "type": "string" }, - "content": { - "type": "string" - }, "sha": { "type": "string" }, @@ -108379,9 +116645,7 @@ "sha", "size", "type", - "url", - "content", - "encoding" + "url" ] }, "content-directory": { @@ -108884,6 +117148,53 @@ "payload": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true + } + } + } + } + } + } + }, + "secret-scanning-push-protection-bypass-placeholder-id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "repository-rule-violation-error": { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + }, + "token_type": { + "type": "string" + } + } + } } } } @@ -108967,6 +117278,9 @@ }, "name": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -109226,6 +117540,11 @@ "example": "SPDX-2.3", "description": "The version of the SPDX specification that this document conforms to." }, + "comment": { + "type": "string", + "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/", + "description": "An optional comment about the SPDX document." + }, "creationInfo": { "type": "object", "properties": { @@ -109258,17 +117577,9 @@ "example": "CC0-1.0", "description": "The license under which the SPDX document is licensed." }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "example": "github/github" - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", - "example": "https://github.com/example/dependency_graph/sbom-123", + "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "description": "The namespace for the SPDX document." }, "packages": { @@ -109283,7 +117594,7 @@ }, "name": { "type": "string", - "example": "rubygems:github/github", + "example": "github/github", "description": "The name of the package." }, "versionInfo": { @@ -109316,6 +117627,11 @@ "example": "NOASSERTION", "description": "The distribution source of this package, or NOASSERTION if this was not determined." }, + "copyrightText": { + "type": "string", + "example": "Copyright (c) 1985 GitHub.com", + "description": "The copyright holders of the package, and any dates present with those notices, if available." + }, "externalRefs": { "type": "array", "items": { @@ -109351,8 +117667,33 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "example": "DEPENDS_ON", + "description": "The type of relationship between the two SPDX elements." + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -109362,7 +117703,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -109581,6 +117921,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -109618,7 +117959,7 @@ "example": "production" }, "target_url": { - "description": "Deprecated: the URL to associate with this status.", + "description": "Closing down notice: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", @@ -109708,7 +118049,8 @@ "id": { "description": "The id of the environment.", "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -110184,6 +118526,10 @@ "payload": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -110953,6 +119299,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -112212,6 +120561,7 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 @@ -112232,6 +120582,7 @@ "type": "string" }, "description": { + "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true @@ -112242,6 +120593,7 @@ "type": "string" }, "default": { + "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } @@ -112514,6 +120866,10 @@ "payload": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -112657,14 +121013,16 @@ }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", - "example": 42, "type": "integer", + "format": "int64", + "example": 42, "nullable": true }, "id": { "description": "The ID of the pull request review comment.", - "example": 1, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { "description": "The node ID of the pull request review comment.", @@ -112682,12 +121040,12 @@ "type": "string" }, "position": { - "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", + "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", "example": 1, "type": "integer" }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", + "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", "example": 4, "type": "integer" }, @@ -113168,6 +121526,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -113931,6 +122292,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -114121,596 +122483,13 @@ "type": "string" }, "repo": { - "type": "object", - "nullable": true, - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "spdx_id": { - "type": "string", - "nullable": true - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -114731,567 +122510,13 @@ "type": "string" }, "repo": { - "type": "object", - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -115499,7 +122724,8 @@ "id": { "description": "Unique identifier of the review", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -115603,11 +122829,13 @@ }, "pull_request_review_id": { "type": "integer", + "format": "int64", "example": 42, "nullable": true }, "id": { "type": "integer", + "format": "int64", "example": 10 }, "node_id": { @@ -116044,6 +123272,16 @@ } ] }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, { "allOf": [ { @@ -116153,6 +123391,16 @@ "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } ] }, @@ -116205,7 +123453,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -116225,6 +123473,25 @@ "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -116233,6 +123500,16 @@ "inactive", "unknown" ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true } } }, @@ -116453,7 +123730,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -116468,7 +123745,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -116588,6 +123865,105 @@ } } }, + "secret-scanning-push-protection-bypass-reason": { + "description": "The reason for bypassing push protection.", + "type": "string", + "enum": [ + "false_positive", + "used_in_tests", + "will_fix_later" + ] + }, + "secret-scanning-push-protection-bypass": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "expire_at": { + "type": "string", + "format": "date-time", + "description": "The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "token_type": { + "type": "string", + "description": "The token type this bypass is for." + } + } + }, + "secret-scanning-scan": { + "description": "Information on a single scan performed by secret scanning on the repository", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of scan" + }, + "status": { + "type": "string", + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time that the scan was completed. Empty if the scan is running", + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true + } + } + }, + "secret-scanning-scan-history": { + "type": "object", + "properties": { + "incremental_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "pattern_update_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "backfill_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "custom_pattern_backfill_scans": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/secret-scanning-scan" + }, + { + "type": "object", + "properties": { + "pattern_name": { + "type": "string", + "description": "Name of the custom pattern for custom pattern scans" + }, + "pattern_scope": { + "type": "string", + "description": "Level at which the custom pattern is defined, one of \"repository\", \"organization\", or \"enterprise\"" + } + } + } + ] + } + } + } + }, "repository-advisory-create": { "type": "object", "properties": { @@ -117674,6 +125050,26 @@ } } }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "type": "string" }, @@ -118381,7 +125777,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -118499,6 +125896,9 @@ "type": "string", "format": "date-time", "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -118534,8 +125934,12 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, + "user_view_type": { + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -118634,6 +126038,12 @@ "example": "octocat@github.com", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -118721,11 +126131,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "business_plus": { "type": "boolean" }, @@ -118893,6 +126298,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "name": { @@ -119170,6 +126576,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 3 }, "name": { @@ -119231,7 +126638,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "primary_key_id": { "type": "integer" @@ -119348,7 +126756,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -119531,6 +126940,114 @@ "repo" ] }, + "sigstore-bundle-0": { + "title": "Sigstore Bundle v0.1", + "description": "Sigstore Bundle v0.1", + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": { + "x509CertificateChain": { + "type": "object", + "properties": { + "certificates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rawBytes": { + "type": "string" + } + } + } + } + } + }, + "tlogEntries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "logIndex": { + "type": "string" + }, + "logId": { + "type": "object", + "properties": { + "keyId": { + "type": "string" + } + } + }, + "kindVersion": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "integratedTime": { + "type": "string" + }, + "inclusionPromise": { + "type": "object", + "properties": { + "signedEntryTimestamp": { + "type": "string" + } + } + }, + "inclusionProof": { + "type": "string", + "nullable": true + }, + "canonicalizedBody": { + "type": "string" + } + } + } + }, + "timestampVerificationData": { + "type": "string", + "nullable": true + } + } + }, + "dsseEnvelope": { + "type": "object", + "properties": { + "payload": { + "type": "string" + }, + "payloadType": { + "type": "string" + }, + "signatures": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sig": { + "type": "string" + }, + "keyid": { + "type": "string" + } + } + } + } + } + } + } + }, "hovercard": { "title": "Hovercard", "description": "Hovercard", @@ -119578,7 +127095,7 @@ }, "enterprise-webhooks": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"\n", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -119746,7 +127263,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -120519,7 +128037,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -120672,125 +128190,6 @@ "updated_at" ] }, - "simple-user-webhooks": { - "title": "Simple User", - "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, "webhooks_rule": { "title": "branch protection rule", "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", @@ -120851,6 +128250,19 @@ "everyone" ] }, + "lock_branch_enforcement_level": { + "description": "The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone.", + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "lock_allows_fork_sync": { + "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.", + "type": "boolean" + }, "merge_queue_enforcement_level": { "type": "string", "enum": [ @@ -120946,6 +128358,7 @@ "strict_required_status_checks_policy", "signature_requirement_enforcement_level", "linear_history_requirement_enforcement_level", + "lock_branch_enforcement_level", "admin_enforced", "allow_force_pushes_enforcement_level", "allow_deletions_enforcement_level", @@ -121236,6 +128649,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -121358,6 +128774,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -121546,7 +128965,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -121591,6 +129011,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121698,6 +129121,131 @@ "format": "date-time" }, "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", + "format": "int64" + }, + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "answer_chosen_at": { + "type": "string", + "nullable": true + }, + "answer_chosen_by": { "title": "User", "type": "object", "nullable": true, @@ -121782,127 +129330,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body" - ] - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "answer_chosen_at": { - "type": "string", - "nullable": true - }, - "answer_chosen_by": { - "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": { + "user_view_type": { "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": [ @@ -122126,7 +129556,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -122171,12 +129602,21 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ "login", "id" ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } } }, "required": [ @@ -122340,7 +129780,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -122385,6 +129826,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122671,7 +130115,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -122717,6 +130162,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122860,6 +130308,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122955,6 +130406,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123169,6 +130623,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123429,6 +130886,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123789,6 +131249,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -123819,6 +131299,145 @@ "format": "uri" }, "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", + "format": "int64" + }, + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "webhooks_milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": "object", "nullable": true, @@ -123904,141 +131523,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - "webhooks_milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "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": { + "user_view_type": { "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", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ @@ -124217,6 +131704,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124311,6 +131801,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124524,6 +132017,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124782,6 +132278,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125141,6 +132640,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -125210,7 +132729,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -125255,6 +132775,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125373,6 +132896,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125751,7 +133277,7 @@ "merge-group": { "type": "object", "title": "Merge Group", - "description": "A group of pull requests that the merge queue has grouped together to be merged.\n", + "description": "A group of pull requests that the merge queue has grouped together to be merged.", "properties": { "head_sha": { "description": "The SHA of the merge group.", @@ -125789,7 +133315,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -126562,7 +134089,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -126818,6 +134345,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126954,7 +134484,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -126999,6 +134530,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127152,6 +134686,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -127177,6 +134719,8 @@ "repository_count", "repositories", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -127294,6 +134838,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127441,6 +134988,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127709,6 +135259,118 @@ "archived_at" ] }, + "projects-v2-single-select-option": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "name" + ] + }, + "projects-v2-iteration-setting": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "duration": { + "type": "number", + "nullable": true + }, + "start_date": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "title" + ] + }, + "projects-v2-status-update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + }, "webhooks_number": { "description": "The pull request number.", "type": "integer" @@ -127770,7 +135432,7 @@ ] }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**", "type": "boolean", "default": false } @@ -128001,6 +135663,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128220,6 +135885,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128448,7 +136116,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -128650,6 +136319,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128933,7 +136605,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -128978,6 +136651,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129239,7 +136915,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -129441,6 +137118,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129724,7 +137404,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -129769,6 +137450,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129953,6 +137637,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130064,6 +137751,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130591,7 +138281,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -130637,6 +138328,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130957,7 +138651,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131002,6 +138697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131164,7 +138862,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131209,6 +138908,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131491,6 +139193,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131916,6 +139621,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -132259,6 +139967,10 @@ "type": "string", "description": "The type of secret that secret scanning detected." }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -132281,6 +139993,35 @@ "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true } } }, @@ -132304,6 +140045,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -132502,6 +140246,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -132596,6 +140343,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132688,6 +140438,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132980,7 +140733,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133012,7 +140765,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133047,7 +140800,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133083,7 +140836,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133173,6 +140926,62 @@ "from" ] }, + "lock_branch_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "lock_allows_fork_sync": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "pull_request_reviews_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "require_last_push_approval": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, "required_status_checks": { "type": "object", "properties": { @@ -133221,7 +141030,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133254,7 +141063,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133300,7 +141109,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133356,7 +141165,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133403,7 +141212,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133533,6 +141342,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -133625,6 +141439,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134196,7 +142013,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134314,6 +142131,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "Client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -134406,6 +142228,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134975,7 +142800,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135088,6 +142913,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The Client ID for the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -135180,6 +143010,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135748,7 +143581,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135868,6 +143701,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136064,7 +143900,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136185,6 +144021,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136406,7 +144245,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136597,6 +144436,7 @@ "state": { "description": "State of a code scanning alert.", "type": "string", + "nullable": true, "enum": [ "open", "dismissed" @@ -136666,7 +144506,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136788,6 +144628,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137012,7 +144855,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137266,7 +145109,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137485,7 +145328,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137509,7 +145352,7 @@ ] }, "comment": { - "description": "The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource.", + "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource.", "type": "object", "properties": { "author_association": { @@ -137661,7 +145504,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -137706,6 +145550,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137743,7 +145590,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137793,7 +145640,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137817,7 +145664,7 @@ ] }, "definition": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -137829,13 +145676,12 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", - "definition", - "organization" + "definition" ] }, "webhook-custom-property-deleted": { @@ -137870,13 +145716,12 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", - "definition", - "organization" + "definition" ] }, "webhook-custom-property-updated": { @@ -137890,7 +145735,7 @@ ] }, "definition": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -137902,13 +145747,12 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", - "definition", - "organization" + "definition" ] }, "webhook-custom-property-values-updated": { @@ -137934,7 +145778,7 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "new_property_values": { "type": "array", @@ -137990,7 +145834,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138027,7 +145871,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138063,7 +145907,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138099,7 +145943,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138135,7 +145979,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138171,7 +146015,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138207,7 +146051,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138243,7 +146087,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138279,7 +146123,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138315,7 +146159,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138428,6 +146272,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138641,6 +146488,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138983,7 +146833,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -139078,6 +146928,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139787,6 +147640,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139886,7 +147742,7 @@ "$ref": "#/components/schemas/simple-installation" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } } }, @@ -139921,7 +147777,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -140052,6 +147908,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140267,6 +148126,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -140618,6 +148480,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -140765,6 +148630,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140854,7 +148722,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -140986,6 +148854,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141198,6 +149069,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -141549,6 +149423,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -141695,6 +149572,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141873,6 +149753,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141890,7 +149773,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -142025,6 +149908,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142237,6 +150123,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -142588,6 +150477,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -142735,6 +150627,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142989,6 +150884,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143203,6 +151101,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143624,6 +151525,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143836,6 +151740,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144164,7 +152071,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -144259,6 +152166,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144969,6 +152879,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145055,7 +152968,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145155,7 +153068,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145192,7 +153105,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145231,7 +153144,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145271,7 +153184,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145330,7 +153243,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145368,7 +153281,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145404,7 +153317,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145467,7 +153380,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145506,7 +153419,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145543,7 +153456,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145579,7 +153492,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145615,7 +153528,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145666,7 +153579,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145700,7 +153613,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145739,7 +153652,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145776,7 +153689,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145812,7 +153725,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145925,11 +153838,6 @@ } ] }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -146028,7 +153936,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -146213,6 +154122,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146746,7 +154658,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146766,7 +154678,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146837,7 +154749,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146875,7 +154787,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146913,7 +154825,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146951,7 +154863,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147019,7 +154931,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147098,7 +155010,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147140,7 +155052,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147263,6 +155175,9 @@ }, "website_url": { "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147318,7 +155233,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "target_type": { "type": "string" @@ -147361,7 +155276,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147525,7 +155440,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -147570,6 +155486,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147704,6 +155623,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147799,6 +155721,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148013,6 +155938,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148273,6 +156201,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148634,6 +156565,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -148703,7 +156654,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -148749,6 +156701,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148874,6 +156829,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149064,7 +157022,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -149115,7 +157074,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149250,6 +157209,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149345,6 +157307,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149559,6 +157524,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149817,6 +157785,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150176,6 +158147,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -150245,7 +158236,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -150291,6 +158283,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150416,6 +158411,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150606,7 +158604,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -150637,6 +158636,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -150657,7 +158659,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -150795,6 +158797,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150890,6 +158895,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151104,6 +159112,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151364,6 +159375,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151724,6 +159738,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -151793,7 +159827,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -151839,6 +159874,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151964,6 +160002,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152154,7 +160195,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -152205,7 +160247,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -152247,7 +160289,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -152379,6 +160421,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152474,6 +160519,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152688,6 +160736,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152949,6 +161000,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153309,6 +161363,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -153378,7 +161452,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -153424,6 +161499,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153612,7 +161690,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -153643,6 +161722,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -153661,7 +161743,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -153788,6 +161870,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154095,6 +162180,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154354,6 +162442,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154713,6 +162804,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -154782,7 +162893,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -154827,6 +162939,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154866,7 +162981,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155349,6 +163464,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -155600,6 +163718,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -155945,6 +164066,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -156018,7 +164159,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -156064,6 +164206,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -156079,7 +164224,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156237,6 +164382,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156546,6 +164694,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156807,6 +164958,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157167,6 +165321,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -157236,7 +165410,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -157282,6 +165457,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157324,7 +165502,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -157453,6 +165631,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157762,6 +165943,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158022,6 +166206,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158382,6 +166569,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -158451,7 +166658,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -158497,6 +166705,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158539,7 +166750,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -158694,6 +166905,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -158788,6 +167002,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -159023,6 +167240,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -159276,6 +167496,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -159620,6 +167843,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -159693,7 +167936,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -159738,6 +167982,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -159750,7 +167997,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160231,6 +168478,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -160483,6 +168733,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -160828,6 +169081,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -160901,7 +169174,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -160946,6 +169220,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -160961,7 +169238,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -161087,6 +169364,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161181,6 +169461,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161394,6 +169677,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161652,6 +169938,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162011,6 +170300,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -162080,7 +170389,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -162125,6 +170435,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162356,7 +170669,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -162541,6 +170855,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162871,6 +171188,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162965,6 +171285,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163179,6 +171502,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163440,6 +171766,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163800,6 +172129,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -163869,7 +172218,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -163914,6 +172264,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163953,7 +172306,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163989,7 +172342,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164472,6 +172825,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -164725,6 +173081,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -165071,6 +173430,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -165144,7 +173523,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -165190,6 +173570,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -165202,7 +173585,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165326,6 +173709,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165420,6 +173806,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165633,6 +174022,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165891,6 +174283,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166250,6 +174645,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -166319,7 +174734,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -166364,6 +174780,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166596,7 +175015,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -166781,6 +175201,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167021,7 +175444,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167062,7 +175485,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167101,7 +175524,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167256,6 +175679,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -167350,6 +175776,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -167585,6 +176014,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -167836,6 +176268,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -168180,6 +176615,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -168253,7 +176708,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -168298,6 +176754,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -168310,7 +176769,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168346,7 +176805,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168382,7 +176841,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168417,7 +176876,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168495,7 +176954,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168537,7 +176996,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168688,7 +177147,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168838,7 +177297,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168988,7 +177447,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169030,7 +177489,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169100,7 +177559,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169167,7 +177626,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169204,7 +177663,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169331,6 +177790,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169469,6 +177931,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169511,7 +177976,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169550,7 +178015,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169707,7 +178172,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169742,7 +178207,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169778,7 +178243,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169814,7 +178279,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169892,7 +178357,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169929,7 +178394,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169965,7 +178430,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170001,7 +178466,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170037,7 +178502,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170072,7 +178537,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170211,6 +178676,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170256,7 +178724,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -170295,7 +178763,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170344,7 +178812,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170535,6 +179003,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170634,6 +179105,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171070,6 +179544,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171219,7 +179696,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171359,6 +179836,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171457,6 +179937,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171667,6 +180150,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171822,7 +180308,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171947,6 +180433,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171992,7 +180481,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172015,11 +180504,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -172046,11 +180538,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -172077,11 +180572,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -172091,8 +180589,7 @@ "action", "personal_access_token_request", "organization", - "sender", - "installation" + "sender" ] }, "webhook-personal-access-token-request-denied": { @@ -172111,8 +180608,11 @@ "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -172230,7 +180730,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "zen": { "description": "Random string of GitHub zen.", @@ -172296,7 +180796,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172332,7 +180832,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172474,6 +180974,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172523,7 +181026,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172578,7 +181081,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172741,6 +181244,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172895,7 +181401,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172930,7 +181436,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172965,7 +181471,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172999,7 +181505,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173049,7 +181555,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173084,7 +181590,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173119,7 +181625,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173154,7 +181660,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173218,7 +181724,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173252,7 +181758,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173281,7 +181787,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173311,7 +181817,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173341,7 +181847,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173424,7 +181930,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173458,7 +181964,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173506,7 +182012,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173537,7 +182043,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173567,7 +182073,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173588,6 +182094,7 @@ ] }, "changes": { + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.", "oneOf": [ { "type": "object", @@ -173600,6 +182107,46 @@ }, "field_type": { "type": "string" + }, + "field_name": { + "type": "string" + }, + "project_number": { + "type": "integer" + }, + "from": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] + }, + "to": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] } } } @@ -173641,7 +182188,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173689,7 +182236,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173723,7 +182270,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173754,7 +182301,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173764,6 +182311,171 @@ "sender" ] }, + "webhook-projects-v2-status-update-created": { + "title": "Projects v2 Status Update Created Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, + "webhook-projects-v2-status-update-deleted": { + "title": "Projects v2 Status Update Deleted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, + "webhook-projects-v2-status-update-edited": { + "title": "Projects v2 Status Update Edited Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + }, + "status": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "to": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + } + } + }, + "start_date": { + "type": "object", + "properties": { + "from": { + "type": "string", + "format": "date", + "nullable": true + }, + "to": { + "type": "string", + "format": "date", + "nullable": true + } + } + }, + "target_date": { + "type": "object", + "properties": { + "from": { + "type": "string", + "format": "date", + "nullable": true + }, + "to": { + "type": "string", + "format": "date", + "nullable": true + } + } + } + } + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, "webhook-public": { "title": "public event", "type": "object", @@ -173781,7 +182493,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174037,6 +182749,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174132,6 +182847,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174256,6 +182974,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174484,7 +183205,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -174686,6 +183408,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174825,7 +183550,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -174969,7 +183694,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -175014,6 +183740,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175277,7 +184006,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -175479,6 +184209,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175618,7 +184351,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -175762,7 +184495,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -175807,6 +184541,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175990,6 +184727,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176101,6 +184841,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176283,6 +185026,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176638,7 +185384,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -176684,6 +185431,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176735,7 +185485,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -176991,6 +185741,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177209,6 +185962,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177437,7 +186193,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -177639,6 +186396,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177778,7 +186538,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -177922,7 +186682,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -177967,6 +186728,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178228,7 +186992,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -178430,6 +187195,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178569,7 +187337,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -178713,7 +187481,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -178758,6 +187527,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178941,6 +187713,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179051,6 +187826,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179233,6 +188011,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179588,7 +188369,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -179634,6 +188416,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179688,7 +188473,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179944,6 +188729,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180162,6 +188950,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180390,7 +189181,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -180592,6 +189384,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180731,7 +189526,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -180875,7 +189670,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -180920,6 +189716,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181383,6 +190182,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181522,7 +190324,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -181666,7 +190468,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -181711,6 +190514,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181894,6 +190700,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182005,6 +190814,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182187,6 +190999,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182542,7 +191357,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -182588,6 +191404,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182642,7 +191461,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182682,7 +191501,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182722,7 +191541,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182762,7 +191581,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -183016,6 +191835,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183234,6 +192056,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183462,7 +192287,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -183664,6 +192490,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183803,7 +192632,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -183947,7 +192776,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -183992,6 +192822,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184253,7 +193086,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -184455,6 +193289,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184594,7 +193431,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -184738,7 +193575,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184783,6 +193621,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184966,6 +193807,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185077,6 +193921,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185258,6 +194105,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185604,7 +194454,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -185650,6 +194501,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185698,13 +194552,27 @@ ] }, "reason": { - "type": "string" + "type": "string", + "enum": [ + "UNKNOWN_REMOVAL_REASON", + "MANUAL", + "MERGE", + "MERGE_CONFLICT", + "CI_FAILURE", + "CI_TIMEOUT", + "ALREADY_MERGED", + "QUEUE_CLEARED", + "ROLL_BACK", + "BRANCH_PROTECTIONS", + "GIT_TREE_INVALID", + "INVALID_MERGE_COMMIT" + ] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -185806,7 +194674,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -186061,6 +194929,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186279,6 +195150,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186507,7 +195381,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -186709,6 +195584,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186848,7 +195726,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -186992,7 +195870,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187037,6 +195916,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187298,7 +196180,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -187500,6 +196383,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187639,7 +196525,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -187783,7 +196669,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187828,6 +196715,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188011,6 +196901,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188122,6 +197015,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188303,6 +197199,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188649,7 +197548,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -188695,6 +197595,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188746,7 +197649,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -189005,6 +197908,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189224,6 +198130,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189452,7 +198361,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -189654,6 +198564,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189793,7 +198706,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -189937,7 +198850,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -189982,6 +198896,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190245,7 +199162,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -190447,6 +199365,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190586,7 +199507,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -190730,7 +199651,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -190775,6 +199697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190959,6 +199884,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191070,6 +199998,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191252,6 +200183,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191607,7 +200541,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -191653,6 +200588,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191704,7 +200642,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -191959,6 +200897,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192178,6 +201119,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192406,7 +201350,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -192608,6 +201553,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192747,7 +201695,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -192891,7 +201839,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -192936,6 +201885,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193199,7 +202151,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -193401,6 +202354,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193540,7 +202496,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -193684,7 +202640,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193729,6 +202686,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193913,6 +202873,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194023,6 +202986,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194205,6 +203171,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194560,7 +203529,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -194606,6 +203576,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194657,7 +203630,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -194697,7 +203670,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -194736,7 +203709,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -194776,7 +203749,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -194816,7 +203789,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -195111,7 +204084,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -195156,6 +204130,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195420,6 +204397,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195639,6 +204619,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195867,7 +204850,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -196069,6 +205053,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196208,7 +205195,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -196352,7 +205339,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196397,6 +205385,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196644,7 +205635,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -196846,6 +205838,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196985,7 +205980,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -197128,7 +206123,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -197173,6 +206169,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197359,6 +206358,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197536,6 +206538,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197885,7 +206890,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -197931,6 +206937,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197980,7 +206989,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -198231,6 +207240,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198449,6 +207461,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198677,7 +207692,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -198879,6 +207895,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199018,7 +208037,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -199162,7 +208181,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199207,6 +208227,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199454,7 +208477,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -199656,6 +208680,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199795,7 +208822,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -199939,7 +208966,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199984,6 +209012,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200169,6 +209200,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200345,6 +209379,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200685,7 +209722,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -200731,6 +209769,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200780,7 +209821,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -201034,6 +210075,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201128,6 +210172,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201252,6 +210299,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201480,7 +210530,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -201682,6 +210733,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201821,7 +210875,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -201965,7 +211019,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202010,6 +211065,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202257,7 +211315,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -202459,6 +211518,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202598,7 +211660,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -202742,7 +211804,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202787,6 +211850,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202973,6 +212039,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203149,6 +212218,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203489,7 +212561,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -203532,6 +212605,9 @@ "Mannequin" ] }, + "user_view_type": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -203584,7 +212660,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -203835,6 +212911,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204054,6 +213133,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204282,7 +213364,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -204484,6 +213567,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204623,7 +213709,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -204767,7 +213853,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -204812,6 +213899,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205059,7 +214149,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -205261,6 +214352,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205400,7 +214494,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -205544,7 +214638,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -205589,6 +214684,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205774,6 +214872,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205951,6 +215052,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206300,7 +215404,238 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" + }, + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "description": "The review that was affected.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the review.", + "type": "string", + "nullable": true + }, + "commit_id": { + "description": "A commit SHA for the review.", + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the review", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_request_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "dismissed", + "approved", + "changes_requested" + ] + }, + "submitted_at": { + "type": "string", + "format": "date-time" + }, + "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", + "format": "int64" }, "login": { "type": "string" @@ -206346,232 +215681,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "id", - "node_id", - "html_url", - "diff_url", - "patch_url", - "issue_url", - "number", - "state", - "locked", - "title", - "user", - "body", - "created_at", - "updated_at", - "closed_at", - "merged_at", - "merge_commit_sha", - "assignee", - "assignees", - "requested_reviewers", - "requested_teams", - "labels", - "milestone", - "draft", - "commits_url", - "review_comments_url", - "review_comment_url", - "comments_url", - "statuses_url", - "head", - "base", - "_links", - "author_association", - "auto_merge", - "active_lock_reason" - ] - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "review": { - "description": "The review that was affected.", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "html": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] }, - "pull_request": { - "title": "Link", - "type": "object", - "properties": { - "href": { - "type": "string", - "format": "uri-template" - } - }, - "required": [ - "href" - ] - } - }, - "required": [ - "html", - "pull_request" - ] - }, - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "description": "The text of the review.", - "type": "string", - "nullable": true - }, - "commit_id": { - "description": "A commit SHA for the review.", - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "description": "Unique identifier of the review", - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "pull_request_url": { - "type": "string", - "format": "uri" - }, - "state": { - "type": "string", - "enum": [ - "dismissed", - "approved", - "changes_requested" - ] - }, - "submitted_at": { - "type": "string", - "format": "date-time" - }, - "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": { + "user_view_type": { "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", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ @@ -206595,7 +215707,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -206862,6 +215974,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207081,6 +216196,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207304,7 +216422,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -207489,6 +216608,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207745,7 +216867,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -207790,6 +216913,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208032,7 +217158,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -208217,6 +217344,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208473,7 +217603,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -208518,6 +217649,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208704,6 +217838,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208881,6 +218018,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209230,7 +218370,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -209276,6 +218417,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209330,7 +218474,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -209589,6 +218733,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209683,6 +218830,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209807,6 +218957,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210035,7 +219188,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -210237,6 +219391,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210376,7 +219533,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -210520,7 +219677,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -210565,6 +219723,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210826,7 +219987,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -211028,6 +220190,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211167,7 +220332,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -211311,7 +220476,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -211356,6 +220522,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211539,6 +220708,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211649,6 +220821,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211830,6 +221005,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212194,7 +221372,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -212239,6 +221418,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212374,6 +221556,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212382,7 +221567,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -212638,6 +221823,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212732,6 +221920,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212856,6 +222047,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213084,7 +222278,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -213286,6 +222481,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213425,7 +222623,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -213569,7 +222767,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -213614,6 +222813,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213875,7 +223077,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -214077,6 +223280,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214216,7 +223422,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -214360,7 +223566,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214405,6 +223612,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214588,6 +223798,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214698,6 +223911,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214879,6 +224095,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215243,7 +224462,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -215288,6 +224508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215477,7 +224700,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -215739,6 +224962,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215834,6 +225060,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215958,6 +225187,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216186,7 +225418,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -216388,6 +225621,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216527,7 +225763,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -216671,7 +225907,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -216716,6 +225953,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216977,7 +226217,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -217179,6 +226420,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217318,7 +226562,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -217462,7 +226706,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217507,6 +226752,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217690,6 +226938,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217801,6 +227052,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217982,6 +227236,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218337,7 +227594,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -218383,6 +227641,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218519,6 +227780,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218527,7 +227791,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -218784,6 +228048,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218879,6 +228146,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219003,6 +228273,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219231,7 +228504,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -219433,6 +228707,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219572,7 +228849,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -219716,7 +228993,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -219761,6 +229039,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220022,7 +229303,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -220224,6 +229506,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220363,7 +229648,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -220507,7 +229792,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220552,6 +229838,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220735,6 +230024,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220846,6 +230138,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221027,6 +230322,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221373,7 +230671,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -221419,6 +230718,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221599,7 +230901,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -221852,6 +231154,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222071,6 +231376,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222299,7 +231607,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -222501,6 +231810,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222640,7 +231952,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -222784,7 +232096,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222829,6 +232142,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223077,7 +232393,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -223279,6 +232596,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223418,7 +232738,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -223562,7 +232882,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -223607,6 +232928,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223793,6 +233117,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223970,6 +233297,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224319,7 +233649,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -224365,6 +233696,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224419,7 +233753,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -224668,6 +234002,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224886,6 +234223,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225114,7 +234454,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -225299,6 +234640,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225560,7 +234904,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -225605,6 +234950,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225853,7 +235201,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -226038,6 +235387,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226299,7 +235651,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226344,6 +235697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226529,6 +235885,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226706,6 +236065,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227055,7 +236417,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -227101,6 +236464,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227152,7 +236518,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -227433,7 +236799,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -227479,6 +236846,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227771,6 +237141,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227988,6 +237361,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228216,7 +237592,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -228401,6 +237778,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228662,7 +238042,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -228707,6 +238088,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228953,7 +238337,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -229138,6 +238523,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229399,7 +238787,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -229444,6 +238833,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229629,6 +239021,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229805,6 +239200,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230145,7 +239543,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -230190,6 +239589,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230241,7 +239643,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -230521,7 +239923,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -230566,6 +239969,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230871,6 +240277,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231090,6 +240499,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231318,7 +240730,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -231520,6 +240933,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231659,7 +241075,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -231803,7 +241219,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -231848,6 +241265,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232109,7 +241529,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -232311,6 +241732,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232450,7 +241874,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -232594,7 +242018,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -232639,6 +242064,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232822,6 +242250,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232933,6 +242364,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233115,6 +242549,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233470,7 +242907,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -233516,6 +242954,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233567,7 +243008,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233828,6 +243269,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234047,6 +243491,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234276,7 +243723,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -234478,6 +243926,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234617,7 +244068,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -234761,7 +244212,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -234806,6 +244258,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235069,7 +244524,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -235271,6 +244727,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235410,7 +244869,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -235554,7 +245013,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -235599,6 +245059,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235783,6 +245246,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235894,6 +245360,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236076,6 +245545,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236431,7 +245903,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -236477,6 +245950,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236528,7 +246004,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236786,6 +246262,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237005,6 +246484,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237233,7 +246715,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -237435,6 +246918,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237574,7 +247060,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -237718,7 +247204,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -237763,6 +247250,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238026,7 +247516,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -238228,6 +247719,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238367,7 +247861,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -238511,7 +248005,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -238556,6 +248051,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238739,6 +248237,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238850,6 +248351,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239032,6 +248536,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239387,7 +248894,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -239433,6 +248941,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239484,7 +248995,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239739,6 +249250,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239956,6 +249470,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240184,7 +249701,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -240386,6 +249904,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240525,7 +250046,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -240669,7 +250190,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -240714,6 +250236,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240976,7 +250501,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -241178,6 +250704,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -241317,7 +250846,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -241461,7 +250990,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -241506,6 +251036,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -241689,6 +251222,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -241799,6 +251335,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -241980,6 +251519,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242326,7 +251868,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -242371,6 +251914,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242422,7 +251968,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242938,7 +252484,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -243123,6 +252670,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243342,7 +252892,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -243460,6 +253010,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243546,6 +253099,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244005,6 +253561,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -244124,7 +253683,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -244231,6 +253790,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244316,6 +253878,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244499,6 +254064,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244639,7 +254207,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -244674,7 +254242,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -244710,7 +254278,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -244787,7 +254355,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245097,6 +254665,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -245224,7 +254795,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245259,7 +254830,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245294,7 +254865,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245329,7 +254900,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245364,7 +254935,7 @@ "$ref": "#/components/schemas/repository-advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245399,7 +254970,7 @@ "$ref": "#/components/schemas/repository-advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245431,7 +255002,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245463,7 +255034,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245495,7 +255066,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245534,7 +255105,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245621,7 +255192,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245648,7 +255219,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "status": { "type": "string", @@ -245688,7 +255259,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245720,7 +255291,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245779,7 +255350,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245815,7 +255386,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -245850,7 +255421,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246034,7 +255605,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246171,7 +255742,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -246216,6 +255788,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -246248,7 +255823,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246281,7 +255856,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246316,7 +255891,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246465,6 +256040,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -246522,7 +256100,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246558,7 +256136,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246758,7 +256336,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246794,7 +256372,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246829,7 +256407,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246852,14 +256430,14 @@ "payload" ] }, - "webhook-secret-scanning-alert-reopened": { - "title": "secret_scanning_alert reopened event", + "webhook-secret-scanning-alert-publicly-leaked": { + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "publicly_leaked" ] }, "alert": { @@ -246878,7 +256456,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246887,14 +256465,14 @@ "repository" ] }, - "webhook-secret-scanning-alert-resolved": { - "title": "secret_scanning_alert resolved event", + "webhook-secret-scanning-alert-reopened": { + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "reopened" ] }, "alert": { @@ -246913,7 +256491,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246922,14 +256500,14 @@ "repository" ] }, - "webhook-secret-scanning-alert-revoked": { - "title": "secret_scanning_alert revoked event", + "webhook-secret-scanning-alert-resolved": { + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "revoked" + "resolved" ] }, "alert": { @@ -246948,7 +256526,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246983,7 +256561,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246992,6 +256570,93 @@ "repository" ] }, + "webhook-secret-scanning-scan-completed": { + "title": "secret_scanning_scan completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "type": { + "type": "string", + "description": "What type of scan was completed", + "enum": [ + "backfill", + "custom-pattern-backfill", + "pattern-version-backfill" + ] + }, + "source": { + "type": "string", + "description": "What type of content was scanned", + "enum": [ + "git", + "issues", + "pull-requests", + "discussions", + "wiki" + ] + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "secret_types": { + "type": "array", + "description": "List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates", + "items": { + "type": "string" + }, + "nullable": true + }, + "custom_pattern_name": { + "type": "string", + "description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated", + "nullable": true + }, + "custom_pattern_scope": { + "type": "string", + "description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated", + "enum": [ + "repository", + "organization", + "enterprise" + ], + "nullable": true + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "source", + "type", + "started_at", + "completed_at" + ] + }, "webhook-security-advisory-published": { "title": "security_advisory published event", "type": "object", @@ -247018,7 +256683,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -247052,7 +256717,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -247102,6 +256767,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -247238,7 +256906,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -247276,7 +256944,7 @@ "$ref": "#/components/schemas/full-repository" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -247307,7 +256975,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -247342,7 +257010,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -247394,7 +257062,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -247433,7 +257101,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -247474,7 +257142,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -247513,7 +257181,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -247549,7 +257217,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -247587,7 +257255,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -247901,6 +257569,10 @@ }, "verified": { "type": "boolean" + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -248091,7 +257763,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sha": { "description": "The Commit SHA.", @@ -248132,6 +257804,202 @@ "sender" ] }, + "webhook-sub-issues-parent-issue-added": { + "title": "parent issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "parent_issue_added" + ] + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "parent_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "parent_issue_id", + "parent_issue", + "parent_issue_repo", + "sub_issue_id", + "sub_issue" + ] + }, + "webhook-sub-issues-parent-issue-removed": { + "title": "parent issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "parent_issue_removed" + ] + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "parent_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "parent_issue_id", + "parent_issue", + "parent_issue_repo", + "sub_issue_id", + "sub_issue" + ] + }, + "webhook-sub-issues-sub-issue-added": { + "title": "sub-issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "sub_issue_added" + ] + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "sub_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "sub_issue_id", + "sub_issue", + "sub_issue_repo", + "parent_issue_id", + "parent_issue" + ] + }, + "webhook-sub-issues-sub-issue-removed": { + "title": "sub-issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "sub_issue_removed" + ] + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "sub_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "sub_issue_id", + "sub_issue", + "sub_issue_repo", + "parent_issue_id", + "parent_issue" + ] + }, "webhook-team-add": { "title": "team_add event", "type": "object", @@ -248149,7 +258017,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -248375,7 +258243,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -248560,6 +258429,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -248774,7 +258646,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -249000,7 +258872,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -249185,6 +259058,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -249399,7 +259275,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -249626,7 +259502,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -249811,6 +259688,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -250025,7 +259905,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -250338,7 +260218,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -250523,6 +260404,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -250737,7 +260621,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -250965,7 +260849,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -251150,6 +261035,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251364,7 +261252,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -251400,7 +261288,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -251434,7 +261322,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "type": "string" @@ -251471,7 +261359,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -251802,7 +261690,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -252165,7 +262053,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -252373,7 +262261,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -252582,7 +262470,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -252715,6 +262603,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -252747,7 +262638,8 @@ "skipped", "stale", "success", - "timed_out" + "timed_out", + "startup_failure" ] }, "created_at": { @@ -253115,6 +263007,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -253593,6 +263488,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -253756,6 +263654,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -253813,7 +263714,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -254987,152 +264888,155 @@ "url": { "type": "string", "format": "uri" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "workflow_id": { - "type": "integer" - }, - "workflow_url": { - "type": "string", - "format": "uri" - } - } - } - }, - "required": [ - "action", - "repository", - "sender", - "workflow", - "workflow_run" - ] - }, - "webhook-workflow-run-requested": { - "title": "workflow_run requested event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "requested" - ] - }, - "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" - }, - "workflow": { - "$ref": "#/components/schemas/webhooks_workflow" - }, - "workflow_run": { - "title": "Workflow Run", - "type": "object", - "properties": { - "actor": { - "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" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string", + "format": "uri" + } + } + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow", + "workflow_run" + ] + }, + "webhook-workflow-run-requested": { + "title": "workflow_run requested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "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" + }, + "workflow": { + "$ref": "#/components/schemas/webhooks_workflow" + }, + "workflow_run": { + "title": "Workflow Run", + "type": "object", + "properties": { + "actor": { + "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" }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { + "user_view_type": { "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": [ @@ -255487,6 +265391,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -255964,6 +265871,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -256175,6 +266085,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -256335,12 +266248,28 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], "credits": [ { "user": { @@ -256416,6 +266345,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", @@ -256453,6 +266392,7 @@ "value": { "id": 1, "slug": "octoapp", + "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", @@ -256560,7 +266500,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, @@ -256573,7 +266514,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": null } ] }, @@ -256591,6 +266533,7 @@ "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -259098,90 +269041,277 @@ "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" } }, - "copilot-usage-metrics-enterprise": { + "enterprise-code-security-configuration-list": { "value": [ { - "day": "2023-10-15", - "total_suggestions_count": 5000, - "total_acceptances_count": 3000, - "total_lines_suggested": 7000, - "total_lines_accepted": 3500, - "total_active_users": 15, - "total_chat_acceptances": 45, - "total_chat_turns": 350, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3000, - "acceptances_count": 2000, - "lines_suggested": 3000, - "lines_accepted": 1500, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - } - ] - }, + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + }, + "enterprise-code-security-configuration": { + "value": { + "id": 1325, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "code-security-default-configurations": { + "value": [ { - "day": "2023-10-16", - "total_suggestions_count": 5200, - "total_acceptances_count": 5100, - "total_lines_suggested": 5300, - "total_lines_accepted": 5000, - "total_active_users": 15, - "total_chat_acceptances": 57, - "total_chat_turns": 455, - "total_active_chat_users": 12, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3100, - "acceptances_count": 3000, - "lines_suggested": 3200, - "lines_accepted": 3100, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1100, - "acceptances_count": 1000, - "lines_suggested": 1200, - "lines_accepted": 1100, - "active_users": 5 + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 900, - "lines_suggested": 1100, - "lines_accepted": 1000, - "active_users": 5 - } - ] + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + } } ] }, + "code-security-configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "simple-repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + }, "dependabot-alerts-for-organization": { "value": [ { @@ -259229,6 +269359,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -259429,6 +269569,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -259673,8 +269823,33 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", - "validity": "active" + "validity": "active", + "publicly_leaked": false, + "multi_repo": false }, { "number": 1, @@ -259759,8 +269934,14 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } ] }, @@ -259948,7 +270129,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -259956,6 +270138,7 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, + "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { @@ -261026,9 +271209,15 @@ "actions": [ "192.0.2.1" ], + "actions_macos": [ + "192.0.2.1" + ], "dependabot": [ "192.0.2.1" ], + "copilot": [ + "192.0.2.1" + ], "domains": { "website": [ "*.example.com" @@ -261320,6 +271509,25 @@ } ] }, + "billing-usage-report": { + "value": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] + } + }, "organization-full": { "value": { "login": "github", @@ -261376,6 +271584,7 @@ "members_can_fork_private_repositories": false, "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -261571,6 +271780,340 @@ "can_approve_pull_request_reviews": true } }, + "runner-groups-org": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] + } + }, + "runner-group": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + }, + "runner-group-item": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + }, + "minimal-repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, "runner-paginated": { "value": { "total_count": 2, @@ -261947,6 +272490,134 @@ "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } }, + "list-attestations": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + }, "simple-user-items": { "value": [ { @@ -262087,141 +272758,238 @@ "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" } - }, + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + } + ] + }, + "code-security-configuration-list": { + "value": [ { - "number": 3, - "created_at": "2020-02-13T12:29:18Z", - "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", - "html_url": "https://github.com/octocat/hello-world/code-scanning/3", - "state": "dismissed", - "dismissed_by": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "dismissed_at": "2020-02-14T12:29:18Z", - "dismissed_reason": "false positive", - "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", - "rule": { - "id": "js/zipslip", - "severity": "error", - "tags": [ - "security", - "external/cwe/cwe-022" - ], - "description": "Arbitrary file write during zip extraction", - "name": "js/zipslip" - }, - "tool": { - "name": "CodeQL", - "guid": null, - "version": "2.4.0" - }, - "most_recent_instance": { - "ref": "refs/heads/main", - "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", - "environment": "{}", - "state": "open", - "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", - "message": { - "text": "This path depends on a user-provided value." - }, - "location": { - "path": "lib/ab12-gen.js", - "start_line": 917, - "end_line": 917, - "start_column": 7, - "end_column": 18 - }, - "classifications": [] + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 17, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" - } + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" } ] }, + "code-security-configuration-updated": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, "codespaces-list": { "value": { "total_count": 3, @@ -262702,7 +273470,11 @@ "inactive_this_cycle": 11 }, "seat_management_setting": "assign_selected", - "public_code_suggestions": "block" + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" } }, "copilot-seats-list": { @@ -262715,6 +273487,7 @@ "pending_cancellation_date": null, "last_activity_at": "2021-10-14T00:53:32-06:00", "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", "assignee": { "login": "octocat", "id": 1, @@ -262781,6 +273554,161 @@ ] } }, + "copilot-usage-metrics-for-day": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + }, "copilot-usage-metrics-org": { "value": [ { @@ -263138,6 +274066,86 @@ "type": "Organization" } }, + "api-insights-route-stats": { + "value": [ + { + "http_method": "GET", + "api_route": "/repositories/:repository_id", + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, + "api-insights-subject-stats": { + "value": [ + { + "subject_type": "installation", + "subject_id": 954453, + "subject_name": "GitHub Actions", + "integration_id": 124345, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, + "api-insights-summary-stats": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + }, + "api-insights-time-stats": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 + }, + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 + }, + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 + }, + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + }, + "api-insights-user-stats": { + "value": [ + { + "actor_type": "oauth_app", + "actor_id": 954453, + "actor_name": "GitHub Actions", + "oauth_application_id": 1245, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, "installation": { "value": { "id": 1, @@ -263166,6 +274174,7 @@ "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, + "client_id": "Iv1.ab1112223334445c", "target_id": 1, "target_type": "Organization", "permissions": { @@ -263463,6 +274472,7 @@ "pending_cancellation_date": null, "last_activity_at": "2021-10-14T00:53:32-06:00", "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", "assignee": { "login": "octocat", "id": 1, @@ -264139,23 +275149,14 @@ }, "secret_scanning_push_protection": { "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" } } } ] }, - "organization-fine-grained-permission-example": { - "value": [ - { - "name": "read_organization_custom_org_role", - "description": "View organization roles" - }, - { - "name": "write_organization_custom_org_role", - "description": "Manage custom organization roles" - } - ] - }, "organization-role-list": { "value": { "total_count": 2, @@ -264371,6 +275372,8 @@ } }, "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -264412,12 +275415,59 @@ } }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null } ] }, + "org-private-registry-configurations-paginated": { + "value": { + "total_count": 1, + "configurations": [ + { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected" + } + ] + } + }, + "org-private-registry-configuration": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "org-private-registry-configuration-with-selected-repositories": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ], + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "private-registries-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, "project-items": { "value": [ { @@ -264494,10 +275544,12 @@ "updated_at": "2014-03-04T18:58:10Z" } }, - "org-custom-properties": { + "custom-properties": { "value": [ { "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", "value_type": "single_select", "required": true, "default_value": "production", @@ -264510,18 +275562,24 @@ }, { "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", "value_type": "string" }, { "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", "value_type": "string", "description": "Team owning the repository" } ] }, - "org-custom-property": { + "custom-property": { "value": { "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", "value_type": "single_select", "required": true, "default_value": "production", @@ -265192,7 +276250,7 @@ { "id": 21, "actor_id": 12, - "username": "octocat", + "actor_name": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", @@ -265204,7 +276262,7 @@ { "id": 25, "actor_id": 11, - "username": "not-octocat", + "actor_name": "not-octocat", "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", "ref": "refs/heads/i-am-everything", @@ -265220,7 +276278,7 @@ "value": { "id": 21, "actor_id": 12, - "username": "octocat", + "actor_name": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", @@ -265357,6 +276415,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", "score": 9.8 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-123", @@ -265534,6 +276602,16 @@ "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", "score": 1.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 7.1 + } + }, "cwes": [ { "cwe_id": "CWE-456", @@ -266602,6 +277680,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -266847,6 +277931,7 @@ "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, + "allow_forking": true, "subscribers_count": 42, "network_count": 0, "license": { @@ -267127,6 +278212,9 @@ }, "secret_scanning_push_protection": { "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" } } } @@ -268270,6 +279358,68 @@ } ] }, + "attestation": { + "value": { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + } + } + }, "autolink-items": { "value": [ { @@ -268338,7 +279488,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", @@ -268958,7 +280109,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null }, "comment_count": 0 }, @@ -270234,6 +281386,39 @@ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" } }, + "code-scanning-autofix": { + "value": { + "status": "success", + "description": "This fixes an XSS vulnerability by escaping the user input.", + "started_at": "2024-02-14T12:29:18Z" + } + }, + "code-scanning-bad-request": { + "value": { + "message": "The alert_number is not valid", + "documentation_url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert", + "status": "400" + } + }, + "code-scanning-autofix-pending": { + "value": { + "status": "pending", + "description": null, + "started_at": "2024-02-14T12:29:18Z" + } + }, + "code-scanning-autofix-commits": { + "value": { + "target_ref": "refs/heads/fix-bug", + "message": "Let's fix this 🪲!" + } + }, + "code-scanning-autofix-commits-response": { + "value": { + "target_ref": "refs/heads/main", + "sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" + } + }, "code-scanning-alert-instances": { "value": [ { @@ -270509,6 +281694,264 @@ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" } }, + "code-scanning-variant-analysis": { + "summary": "Default response", + "value": { + "id": 1, + "controller_repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "query_language": "python", + "query_pack_url": "https://www.example.com", + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "completed_at": "2022-09-12T13:15:33Z", + "status": "completed", + "actions_workflow_run_id": 3453588, + "scanned_repositories": [ + { + "repository": { + "id": 1296269, + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "private": false + }, + "analysis_status": "succeeded", + "result_count": 532, + "artifact_size_in_bytes": 12345 + } + ], + "skipped_repositories": { + "access_mismatch_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo1", + "full_name": "octo-org/octo-repo1", + "private": false + }, + { + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo2", + "full_name": "octo-org/octo-repo2", + "private": false + } + ] + }, + "not_found_repos": { + "repository_count": 3, + "repository_full_names": [ + "octo-org/octo-repo4", + "octo-org/octo-repo5", + "octo-org/octo-repo6" + ] + }, + "no_codeql_db_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 7, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo7", + "full_name": "octo-org/octo-repo7", + "private": false + }, + { + "id": 8, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo8", + "full_name": "octo-org/octo-repo8", + "private": false + } + ] + }, + "over_limit_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 9, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo9", + "full_name": "octo-org/octo-repo9", + "private": false + }, + { + "id": 10, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo10", + "full_name": "octo-org/octo-repo10", + "private": false + } + ] + } + } + } + }, + "code-scanning-variant-analysis-repo-task": { + "summary": "Default response", + "value": { + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "analysis_status": "succeeded", + "artifact_size_in_bytes": 12345, + "result_count": 532, + "database_commit_sha": "2d870c2a717a524627af38fa2da382188a096f90", + "source_location_prefix": "/", + "artifact_url": "https://example.com" + } + }, "code-scanning-default-setup": { "value": { "state": "configured", @@ -270546,6 +281989,37 @@ "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" } }, + "code-security-configuration-for-repository": { + "value": { + "status": "attached", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + }, "codeowners-errors": { "value": { "errors": [ @@ -271257,7 +282731,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -271873,7 +283348,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -272346,7 +283822,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -272424,7 +283901,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -272507,7 +283985,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -272774,7 +284253,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } } @@ -272828,7 +284308,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } } @@ -272867,7 +284348,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } } @@ -272944,6 +284426,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -273077,6 +284569,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -273188,6 +284690,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -273287,6 +284799,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -273446,19 +284968,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseDeclared": "MIT", + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -274168,7 +285721,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } @@ -274205,7 +285759,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } }, @@ -274266,7 +285821,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } }, @@ -275817,7 +287373,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] }, @@ -275831,7 +287388,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } }, "label": { @@ -275988,6 +287546,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -278861,8 +290421,33 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", - "validity": "inactive" + "validity": "inactive", + "publicly_leaked": false, + "multi_repo": false }, { "number": 1, @@ -278880,8 +290465,14 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } ] }, @@ -278902,8 +290493,14 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } }, "secret-scanning-alert-resolved": { @@ -278942,8 +290539,14 @@ "push_protection_bypassed": false, "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } }, "secret-scanning-location-list": { @@ -279015,7 +290618,7 @@ { "type": "pull_request_title", "details": { - "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, { @@ -279044,6 +290647,70 @@ } ] }, + "secret-scanning-push-protection-bypass": { + "value": { + "reason": "will_fix_later", + "expire_at": "2020-11-06T18:18:30Z", + "token_type": "mailchimp_api_key" + } + }, + "secret-scanning-scan-history": { + "value": { + "incremental_scans": [ + { + "type": "git", + "status": "completed", + "completed_at": "2024-10-07T02:47:00Z" + } + ], + "backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:50:00Z" + }, + { + "type": "issue", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:49:00Z" + }, + { + "type": "discussion", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:48:00Z" + } + ], + "pattern_update_scans": [ + { + "type": "discussion", + "status": "in_progress", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:51:00Z" + } + ], + "custom_pattern_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z", + "pattern_slug": "my-custom-pattern", + "pattern_scope": "enterprise" + }, + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z", + "pattern_slug": "my-custom-pattern", + "pattern_scope": "organization" + } + ] + } + }, "repository-advisory": { "value": { "ghsa_id": "GHSA-abcd-1234-efgh", @@ -279138,6 +290805,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", "score": 9.8 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-123", @@ -279350,6 +291027,10 @@ } ], "cvss": null, + "cvss_severities": { + "cvss_v3": null, + "cvss_v4": null + }, "cwes": [ { "cwe_id": "CWE-123", @@ -281172,254 +292853,6 @@ "selected_repositories_url": "https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories" } }, - "minimal-repository-paginated": { - "value": { - "total_count": 1, - "repositories": [ - { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "organization": null, - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - ] - } - }, "user-export-details": { "value": { "state": "succeeded", @@ -285607,7 +297040,9 @@ "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false }, "location": { "type": "commit", @@ -285896,6 +297331,15 @@ "type": "string" } }, + "configuration-id": { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -285992,7 +297436,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -286030,6 +297474,26 @@ "type": "string" } }, + "secret-scanning-alert-publicly-leaked": { + "name": "is_publicly_leaked", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-multi-repo": { + "name": "is_multi_repo", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, "gist-id": { "name": "gist_id", "description": "The unique identifier of the gist.", @@ -286045,7 +297509,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "labels": { @@ -286164,6 +297629,42 @@ "type": "string" } }, + "billing-usage-report-year": { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-month": { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-day": { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-hour": { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, "repository-id": { "name": "repository_id", "description": "The unique identifier of the repository.", @@ -286173,6 +297674,24 @@ "type": "integer" } }, + "visible-to-repository": { + "name": "visible_to_repository", + "description": "Only return runner groups that are allowed to be used by this repository.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "runner-group-id": { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "runner-id": { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", @@ -286254,6 +297773,135 @@ "type": "integer" } }, + "api-insights-actor-type": { + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, + "schema": { + "type": "string", + "enum": [ + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] + } + }, + "api-insights-actor-id": { + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + }, + "api-insights-min-timestamp": { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-max-timestamp": { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-route-stats-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "http_method", + "api_route", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + "api-insights-api-route-substring": { + "name": "api_route_substring", + "in": "query", + "description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + "api-insights-subject-name-substring": { + "name": "subject_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-user-id": { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-timestamp-increment": { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-actor-name-substring": { + "name": "actor_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, "invitation-id": { "name": "invitation_id", "description": "The unique identifier of the invitation.", @@ -286435,19 +298083,38 @@ }, "custom-property-name": { "name": "custom_property_name", - "description": "The custom property name. The name is case sensitive.", + "description": "The custom property name", "in": "path", "required": true, "schema": { "type": "string" } }, + "ruleset-targets": { + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "branch,tag,push" + } + }, + "ref-in-query": { + "name": "ref", + "description": "The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "query", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "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.", + "description": "The name of the repository to filter on.", "in": "query", "schema": { - "type": "integer" + "type": "string" } }, "time-period": { @@ -286871,6 +298538,15 @@ "$ref": "#/components/schemas/code-scanning-ref" } }, + "pr-alias": { + "name": "pr", + "description": "The number of the pull request for the results you want to list.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, "alert-number": { "name": "alert_number", "in": "path", @@ -287061,15 +298737,6 @@ "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.", @@ -287279,8 +298946,8 @@ } } }, - "internal_error": { - "description": "Internal Error", + "conflict": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -287289,6 +298956,9 @@ } } }, + "no_content": { + "description": "A header with no content is returned." + }, "service_unavailable": { "description": "Service unavailable", "content": { @@ -287353,8 +299023,23 @@ } } }, - "conflict": { - "description": "Conflict", + "billing_usage_report_org": { + "description": "Billing usage report response for an organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-usage-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-usage-report" + } + } + } + } + }, + "internal_error": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -287451,12 +299136,19 @@ } } }, + "usage_metrics_api_disabled": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, - "no_content": { - "description": "A header with no content is returned." - }, "gone": { "description": "Gone", "content": { @@ -287497,6 +299189,31 @@ } } }, + "code_scanning_bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-bad-request" + } + } + } + } + }, + "code_scanning_autofix_create_forbidden": { + "description": "Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "found": { "description": "Found" }, diff --git a/cache/ghec.json b/cache/ghec.json index 168d23dc9..a0289dec4 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.6.0", + "version": "17.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": { @@ -175,6 +175,22 @@ { "name": "desktop", "description": "Desktop specific endpoints." + }, + { + "name": "dsr", + "description": "Endpoints to manage DSR operations." + }, + { + "name": "enterprise-teams", + "description": "Endpoints to manage GitHub Enterprise Teams." + }, + { + "name": "code-security", + "description": "Endpoints to manage Code security using the REST API." + }, + { + "name": "private-registries", + "description": "Manage private registry configurations." } ], "servers": [ @@ -360,6 +376,22 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/pagination-before" }, @@ -389,7 +421,9 @@ "type": "string", "enum": [ "updated", - "published" + "published", + "epss_percentage", + "epss_percentile" ], "default": "published" } @@ -731,14 +765,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -1770,7 +1796,7 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], @@ -1937,7 +1963,7 @@ "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", - "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" @@ -1997,7 +2023,7 @@ "/applications/{client_id}/token": { "post": { "summary": "Check a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -2070,7 +2096,7 @@ }, "patch": { "summary": "Reset a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -2140,7 +2166,7 @@ }, "delete": { "summary": "Delete an app token", - "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.", + "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], @@ -2200,7 +2226,7 @@ "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", - "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -2319,7 +2345,7 @@ "/apps/{app_slug}": { "get": { "summary": "Get an app", - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", + "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "tags": [ "apps" ], @@ -4395,7 +4421,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "actions", "subcategory": "self-hosted-runners" @@ -4961,7 +4987,7 @@ "get": { "summary": "Get the audit log for an enterprise", "operationId": "enterprise-admin/get-audit-log", - "description": "Gets the audit log for an enterprise.\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an enterprise.\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an enterprise admin to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -5034,6 +5060,403 @@ } } }, + "/enterprises/{enterprise}/audit-log/stream-key": { + "get": { + "summary": "Get the audit log stream key for encrypting secrets", + "description": "Retrieves the audit log streaming public key for encrypting secrets.\n\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api).\"", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-audit-log-stream-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#get-the-audit-log-stream-key-for-encrypting-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "The stream key for the audit log streaming configuration was retrieved successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/audit-log-stream-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/audit-log-stream-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/audit-log/streams": { + "get": { + "summary": "List audit log stream configurations for an enterprise", + "description": "Lists the configured audit log streaming configurations for an enterprise.\nThis only lists configured streams for supported providers.\n\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api).\"", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-audit-log-streams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-audit-log-stream-configurations-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-audit-log-stream-configs" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-audit-log-stream-configs" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an audit log streaming configuration for an enterprise", + "description": "Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.\n\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api).\"", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/create-audit-log-stream", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#create-an-audit-log-streaming-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "This setting pauses or resumes a stream." + }, + "stream_type": { + "type": "string", + "description": "The audit log streaming provider. The name is case sensitive.", + "enum": [ + "Azure Blob Storage", + "Azure Event Hubs", + "Amazon S3", + "Splunk", + "HTTPS Event Collector", + "Google Cloud Storage", + "Datadog" + ] + }, + "vendor_specific": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/azure-blob-config" + }, + { + "$ref": "#/components/schemas/azure-hub-config" + }, + { + "$ref": "#/components/schemas/amazon-s3-oidc-config" + }, + { + "$ref": "#/components/schemas/amazon-s3-access-keys-config" + }, + { + "$ref": "#/components/schemas/splunk-config" + }, + { + "$ref": "#/components/schemas/google-cloud-config" + }, + { + "$ref": "#/components/schemas/datadog-config" + } + ] + } + }, + "required": [ + "enabled", + "stream_type", + "vendor_specific" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/audit-log-stream-config-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "The audit log stream configuration was created successfully.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-audit-log-stream-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-audit-log-stream-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/audit-log/streams/{stream_id}": { + "get": { + "summary": "List one audit log streaming configuration via a stream ID", + "description": "Lists one audit log stream configuration via a stream ID.\n\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api).\"", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-one-audit-log-stream", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#list-one-audit-log-streaming-configuration-via-a-stream-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/audit-log-stream-id" + } + ], + "responses": { + "200": { + "description": "Lists one audit log stream configuration via stream ID.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-audit-log-stream-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-audit-log-stream-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "x-octokit": {} + }, + "put": { + "summary": "Update an existing audit log stream configuration", + "description": "Updates an existing audit log stream configuration for an enterprise.\n\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api).\"", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/update-audit-log-stream", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#update-an-existing-audit-log-stream-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/audit-log-stream-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "This setting pauses or resumes a stream." + }, + "stream_type": { + "type": "string", + "description": "The audit log streaming provider. The name is case sensitive.", + "enum": [ + "Azure Blob Storage", + "Azure Event Hubs", + "Amazon S3", + "Splunk", + "HTTPS Event Collector", + "Google Cloud Storage", + "Datadog" + ] + }, + "vendor_specific": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/azure-blob-config" + }, + { + "$ref": "#/components/schemas/azure-hub-config" + }, + { + "$ref": "#/components/schemas/amazon-s3-oidc-config" + }, + { + "$ref": "#/components/schemas/amazon-s3-access-keys-config" + }, + { + "$ref": "#/components/schemas/splunk-config" + }, + { + "$ref": "#/components/schemas/google-cloud-config" + }, + { + "$ref": "#/components/schemas/datadog-config" + } + ] + } + }, + "required": [ + "enabled", + "stream_type", + "vendor_specific" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/audit-log-stream-config-request" + } + } + } + } + }, + "responses": { + "200": { + "description": "Successful update", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-audit-log-stream-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-audit-log-stream-config" + } + } + } + } + }, + "422": { + "description": "Validation error", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an audit log streaming configuration for an enterprise", + "description": "Deletes an existing audit log stream configuration for an enterprise. \n\nWhen using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See \"[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api).\"", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/delete-audit-log-stream", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/audit-log#delete-an-audit-log-streaming-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/audit-log-stream-id" + } + ], + "responses": { + "204": { + "description": "The audit log stream configuration was deleted successfully." + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "audit-log" + }, + "x-octokit": {} + } + }, "/enterprises/{enterprise}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an enterprise", @@ -5136,10 +5559,914 @@ "x-octokit": {} } }, + "/enterprises/{enterprise}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an enterprise", + "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "per_page", + "in": "query", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration-list" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a code security configuration for an enterprise", + "description": "Creates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ], + "default": "disabled" + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "High rish settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations for an enterprise", + "description": "Lists the default code security configurations for an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-default-configurations" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-default-configurations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Retrieve a code security configuration of an enterprise", + "description": "Gets a code security configuration available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-single-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a custom code security configuration for an enterprise", + "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique across the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.", + "enum": [ + "enabled", + "disabled" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-enterprise recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a code security configuration for an enterprise", + "description": "Deletes a code security configuration from an enterprise.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/delete-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach an enterprise configuration to repositories", + "description": "Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/attach-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations" + ] + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "all" + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an enterprise", + "description": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.\n\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with an enterprise code security configuration", + "description": "Lists the repositories associated with an enterprise code security configuration in an organization.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration-repositories" + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "$ref": "#/components/examples/simple-repository" + } + } + ] + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nGets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -5177,13 +6504,16 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update code security and analysis features for an enterprise", - "description": "Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nUpdates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -5229,10 +6559,10 @@ "nullable": true, "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." }, - "secret_scanning_validity_checks_enabled": { + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": { "type": "boolean", "nullable": true, - "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise." + "description": "Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise." } } }, @@ -5245,7 +6575,7 @@ "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md", - "secret_scanning_validity_checks_enabled": true + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": true } } } @@ -5267,8 +6597,11 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" }, + "deprecated": true, "x-octokit": {} } }, @@ -5327,10 +6660,182 @@ "x-octokit": {} } }, + "/enterprises/{enterprise}/copilot/billing/seats": { + "get": { + "summary": "List all Copilot seat assignments for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-seats-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 50 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once." + }, + "seats": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-seat-details" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-seats-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + }, + "x-octokit": {} + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage\nmetrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -5407,7 +6912,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -5554,48 +7059,21 @@ "x-octokit": {} } }, - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/properties/schema": { "get": { - "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users.", + "summary": "Get custom properties for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ - "secret-scanning" + "enterprise-admin" ], - "operationId": "secret-scanning/list-alerts-for-enterprise", + "operationId": "enterprise-admin/get-enterprise-custom-properties", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-custom-properties-for-an-enterprise" }, "parameters": [ { "$ref": "#/components/parameters/enterprise" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-state" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-sort" - }, - { - "$ref": "#/components/parameters/direction" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -5606,169 +7084,1087 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/organization-secret-scanning-alert" + "$ref": "#/components/schemas/custom-property" } }, "examples": { "default": { - "$ref": "#/components/examples/organization-secret-scanning-alert-list" + "$ref": "#/components/examples/custom-properties" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, + "403": { + "$ref": "#/components/responses/forbidden" + }, "404": { "$ref": "#/components/responses/not_found" - }, - "503": { - "$ref": "#/components/responses/service_unavailable" } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "secret-scanning", - "subcategory": "secret-scanning" + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" }, "x-octokit": {} - } - }, - "/enterprises/{enterprise}/settings/billing/actions": { - "get": { - "summary": "Get GitHub Actions billing for an enterprise", - "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.", - "operationId": "billing/get-github-actions-billing-ghe", + }, + "patch": { + "summary": "Create or update custom properties for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ - "billing" + "enterprise-admin" ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-properties", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-custom-properties-for-an-enterprise" }, "parameters": [ { "$ref": "#/components/parameters/enterprise" } ], + "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/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" + ], + "values_editable_by": "org_actors" + }, + { + "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": { - "$ref": "#/components/schemas/actions-billing-usage" + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property" + } }, "examples": { "default": { - "$ref": "#/components/examples/actions-billing-usage" + "$ref": "#/components/examples/custom-properties" } } } } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" } }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "billing" + "subcategory": "custom-properties" }, "x-octokit": {} } }, - "/enterprises/{enterprise}/settings/billing/advanced-security": { + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { "get": { - "summary": "Get GitHub Advanced Security active committers for an enterprise", - "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.", + "summary": "Get a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ - "billing" + "enterprise-admin" ], - "operationId": "billing/get-github-advanced-security-billing-ghe", + "operationId": "enterprise-admin/get-enterprise-custom-property", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-for-an-enterprise" }, "parameters": [ { "$ref": "#/components/parameters/enterprise" }, { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" + "$ref": "#/components/parameters/custom-property-name" } ], "responses": { "200": { - "description": "Success", + "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/advanced-security-active-committers" + "$ref": "#/components/schemas/custom-property" }, "examples": { "default": { - "$ref": "#/components/examples/advanced-security-active-committers" + "$ref": "#/components/examples/custom-property" } } } } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" } }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "billing" + "subcategory": "custom-properties" }, "x-octokit": {} - } - }, - "/enterprises/{enterprise}/settings/billing/packages": { - "get": { - "summary": "Get GitHub Packages billing for an enterprise", - "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nThe authenticated user must be an enterprise admin.", - "operationId": "billing/get-github-packages-billing-ghe", + }, + "put": { + "summary": "Create or update a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ - "billing" + "enterprise-admin" ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-property", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-packages-billing-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-for-an-enterprise" }, "parameters": [ { "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/custom-property-name" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-property-set-payload" + }, + "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/packages-billing-usage" + "$ref": "#/components/schemas/custom-property" }, "examples": { "default": { - "$ref": "#/components/examples/packages-billing-usage" + "$ref": "#/components/examples/custom-property" } } } } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" } }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "billing" + "subcategory": "custom-properties" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/remove-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$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": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/rulesets": { + "post": { + "summary": "Create an enterprise repository ruleset", + "description": "Create a repository ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/create-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get an enterprise repository ruleset", + "description": "Get a repository ruleset for an enterprise.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + }, + "x-octokit": {} + }, + "put": { + "summary": "Update an enterprise repository ruleset", + "description": "Update a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/update-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an enterprise repository ruleset", + "description": "Delete a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for an enterprise", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-alerts-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-secret-type" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-resolution" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-secret-scanning-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-secret-scanning-alert-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "secret-scanning", + "subcategory": "secret-scanning" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/actions": { + "get": { + "summary": "Get GitHub Actions billing for an enterprise", + "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nThe authenticated user must be an enterprise admin.", + "operationId": "billing/get-github-actions-billing-ghe", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-actions-billing-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/advanced-security": { + "get": { + "summary": "Get GitHub Advanced Security active committers for an enterprise", + "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-advanced-security-billing-ghe", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/advanced-security-active-committers" + }, + "examples": { + "default": { + "$ref": "#/components/examples/advanced-security-active-committers" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/cost-centers": { + "get": { + "summary": "Get all cost centers for an enterprise", + "description": "Gets a list of all the cost centers for an enterprise.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-cost-centers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-all-cost-centers-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/get_all_cost_centers" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource": { + "post": { + "summary": "Add users to a cost center", + "description": "Adds users to a cost center.\n\nThe usage for the users will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.", + "tags": [ + "billing" + ], + "operationId": "billing/add-resource-to-cost-center", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-users-to-a-cost-center" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/cost-center" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "description": "The usernames of the users to add to the cost center.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "users" + ] + }, + "examples": { + "default": { + "value": { + "users": [ + "monalisa" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/add_resource_to_cost_center" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove users from a cost center", + "description": "Remove users from a cost center.\n\nThe usage for the users will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.", + "tags": [ + "billing" + ], + "operationId": "billing/remove-resource-from-cost-center", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-users-from-a-cost-center" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/cost-center" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "description": "The usernames of the users to remove from the cost center.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "users" + ] + }, + "examples": { + "default": { + "value": { + "users": [ + "monalisa" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/remove_resource_from_cost_center" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/settings/billing/packages": { + "get": { + "summary": "Get GitHub Packages billing for an enterprise", + "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nThe authenticated user must be an enterprise admin.", + "operationId": "billing/get-github-packages-billing-ghe", + "tags": [ + "billing" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-packages-billing-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/packages-billing-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-billing-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" }, "x-octokit": {} } @@ -5816,10 +8212,256 @@ "x-octokit": {} } }, + "/enterprises/{enterprise}/settings/billing/usage": { + "get": { + "summary": "Get billing usage report for an enterprise", + "description": "Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.\n\n**Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform).\"", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-usage-report-ghe", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + }, + { + "$ref": "#/components/parameters/billing-usage-report-hour" + }, + { + "name": "cost_center_id", + "description": "The ID corresponding to a cost center. The default value is no cost center.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_usage_report" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "billing" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team-slug" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + }, + "x-octokit": {} + } + }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + "get": { + "summary": "Get a summary of Copilot usage for an enterprise team", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/usage-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-org" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage" + }, + "x-octokit": {} + } + }, "/enterprises/{enterprise}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature", - "description": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis).\n\nEnables or disables the specified security feature for all repositories in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], @@ -5854,15 +8496,18 @@ "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "enterprise-admin", - "subcategory": "code-security-and-analysis" + "subcategory": "code-security-and-analysis", + "deprecationDate": "2024-09-27", + "removalDate": "2025-09-27" }, + "deprecated": true, "x-octokit": {} } }, "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -5920,7 +8565,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Cloud global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -6020,7 +8665,7 @@ }, "post": { "summary": "Create a gist", - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "description": "Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", "operationId": "gists/create", "tags": [ "gists" @@ -7418,7 +10063,7 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -7863,7 +10508,7 @@ "/marketplace_listing/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -7919,7 +10564,7 @@ "/marketplace_listing/plans": { "get": { "summary": "List plans", - "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -7979,7 +10624,7 @@ "/marketplace_listing/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan", - "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -8061,7 +10706,7 @@ "/marketplace_listing/stubbed/accounts/{account_id}": { "get": { "summary": "Get a subscription plan for an account (stubbed)", - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -8110,7 +10755,7 @@ "/marketplace_listing/stubbed/plans": { "get": { "summary": "List plans (stubbed)", - "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -8167,7 +10812,7 @@ "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { "get": { "summary": "List accounts for a plan (stubbed)", - "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", + "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", "tags": [ "apps" ], @@ -8243,7 +10888,7 @@ "/meta": { "get": { "summary": "Get GitHub Enterprise Cloud meta information", - "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n**Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", "tags": [ "meta" ], @@ -8285,7 +10930,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -8848,7 +11493,7 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -8907,15 +11552,15 @@ }, "/organizations/{organization_id}/custom_roles": { "get": { - "summary": "Deprecated - List custom repository roles in an organization", - "description": "**Note**: This operation is deprecated and will be removed in the future.\nUse the \"[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Closing down - List custom repository roles in an organization", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#deprecated---list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -8970,10 +11615,65 @@ "x-octokit": {} } }, + "/organizations/{org}/settings/billing/usage": { + "get": { + "summary": "Get billing usage report for an organization", + "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform).\"", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-usage-report-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + }, + { + "$ref": "#/components/parameters/billing-usage-report-hour" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_usage_report_org" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "enhanced-billing" + }, + "x-octokit": {} + } + }, "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -9017,7 +11717,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -9104,7 +11804,7 @@ }, "members_allowed_repository_creation_type": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", "private", @@ -9142,27 +11842,33 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -9174,7 +11880,12 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "deprecated": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } } }, @@ -10029,7 +12740,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10150,7 +12861,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10196,7 +12907,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10295,7 +13006,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10327,7 +13038,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10394,7 +13105,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10459,7 +13170,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10496,7 +13207,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10531,7 +13242,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10603,7 +13314,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10668,7 +13379,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10705,7 +13416,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -10740,7 +13451,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12574,10 +15285,107 @@ "x-octokit": {} } }, + "/orgs/{org}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + }, + "x-octokit": {} + } + }, "/orgs/{org}/audit-log": { "get": { "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\nThis endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)\" and \"[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "operationId": "orgs/get-audit-log", "tags": [ "orgs" @@ -12801,6 +15609,79 @@ "x-octokit": {} } }, + "/orgs/{org}/bypass-requests/push-rules": { + "get": { + "summary": "List push rule bypass requests within an organization", + "description": "Lists the requests made by users of a repository to bypass push protection rules within an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-push-bypass-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/bypass-requests#list-push-rule-bypass-requests-within-an-organization" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "bypass-requests" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-name-in-query" + }, + { + "$ref": "#/components/parameters/bypass-reviewer-name" + }, + { + "$ref": "#/components/parameters/bypass-requester-name" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/bypass-request-status" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/push-rule-bypass-request" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/push-rule-bypass-request-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + } + }, "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", @@ -12911,6 +15792,1077 @@ "x-octokit": {} } }, + "/orgs/{org}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "in": "query", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-list" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ], + "default": "disabled" + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-default-configurations" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-default-configurations" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/detach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to detach from configurations.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + } + }, + "examples": { + "default": { + "summary": "Example for detaching repositories from configurations.", + "value": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-updated" + } + } + } + } + }, + "204": { + "description": "Response when no new updates are made" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/delete-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/attach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations", + "public", + "private_or_internal", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "selected", + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration-repositories" + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "$ref": "#/components/examples/simple-repository" + } + } + ] + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, "/orgs/{org}/codespaces": { "get": { "summary": "List codespaces for the organization", @@ -13796,7 +17748,7 @@ "/orgs/{org}/copilot/billing": { "get": { "summary": "Get Copilot seat information and settings for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)\".\n\nOnly organization owners can configure and view details about the organization's Copilot Business subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13854,7 +17806,7 @@ "/orgs/{org}/copilot/billing/seats": { "get": { "summary": "List all Copilot seat assignments for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13938,7 +17890,7 @@ "/orgs/{org}/copilot/billing/selected_teams": { "post": { "summary": "Add teams to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -13993,7 +17945,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for members of the specified team(s).", "properties": { "seats_created": { "type": "integer" @@ -14039,7 +17991,7 @@ }, "delete": { "summary": "Remove teams from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14094,7 +18046,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", "properties": { "seats_cancelled": { "type": "integer" @@ -14142,7 +18094,7 @@ "/orgs/{org}/copilot/billing/selected_users": { "post": { "summary": "Add users to the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14197,7 +18149,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments created.", + "description": "The total number of seats created for the specified user(s).", "properties": { "seats_created": { "type": "integer" @@ -14243,7 +18195,7 @@ }, "delete": { "summary": "Remove users from the Copilot subscription for an organization", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot pricing, see \"[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)\".\n\nFor more information about disabling access to Copilot Business or Enterprise, see \"[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners can configure GitHub Copilot in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14298,7 +18250,7 @@ "application/json": { "schema": { "type": "object", - "description": "The total number of seat assignments cancelled.", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", "properties": { "seats_cancelled": { "type": "integer" @@ -14343,10 +18295,98 @@ "x-octokit": {} } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + }, + "x-octokit": {} + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nCopilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view\nCopilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nacross an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOrganization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -14819,15 +18859,15 @@ }, "/orgs/{org}/custom_roles": { "post": { - "summary": "Deprecated - Create a custom role", - "description": "**Note**: This operation is deprecated and will be removed after September 6th 2023.\nUse the \"[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)\" endpoint instead.\n\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Closing down - Create a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)\" endpoint instead.\n\nCreates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#deprecated---create-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role" }, "parameters": [ { @@ -14893,15 +18933,15 @@ }, "/orgs/{org}/custom_roles/{role_id}": { "get": { - "summary": "Deprecated - Get a custom role", - "description": "**Note**: This operation is deprecated and will be removed after September 6th 2023.\nUse the \"[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)\" endpoint instead.\n\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Closing down - Get a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)\" endpoint instead.\n\nGets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/get-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#deprecated---get-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role" }, "parameters": [ { @@ -14943,15 +18983,15 @@ "x-octokit": {} }, "patch": { - "summary": "Deprecated - Update a custom role", - "description": "**Note**: This operation is deprecated and will be removed after September 6th 2023.\nUse the \"[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)\" endpoint instead.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Closing down - Update a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)\" endpoint instead.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#deprecated---update-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role" }, "parameters": [ { @@ -15019,15 +19059,15 @@ "x-octokit": {} }, "delete": { - "summary": "Deprecated - Delete a custom role", - "description": "**Note**: This operation is deprecated and will be removed after September 6th 2023.\nUse the \"[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)\" endpoint instead.\n\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Closing down - Delete a custom role", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)\" endpoint instead.\n\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#deprecated---delete-a-custom-role" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role" }, "parameters": [ { @@ -15721,7 +19761,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -15788,6 +19828,12 @@ }, { "$ref": "#/components/parameters/group-id" + }, + { + "$ref": "#/components/parameters/members-per-page" + }, + { + "$ref": "#/components/parameters/members-page" } ], "responses": { @@ -15889,7 +19935,7 @@ "/orgs/{org}/failed_invitations": { "get": { "summary": "List failed organization invitations", - "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", + "description": "The return hash contains `failed_at` and `failed_reason` fields which \nrepresent the time at which the invitation failed and the reason for the failure.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], @@ -15948,15 +19994,15 @@ }, "/orgs/{org}/fine_grained_permissions": { "get": { - "summary": "Deprecated - List fine-grained permissions for an organization", - "description": "**Note**: This operation is deprecated and will be removed after September 6th 2023.\nUse the \"[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" endpoint instead.\n\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Closing down - List fine-grained permissions for an organization", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the \"[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" endpoint instead.\n\nLists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#deprecated---list-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -16535,14 +20581,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -16715,6 +20753,519 @@ "x-octokit": {} } }, + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get route stats by actor", + "description": "Get API request count statistics for an actor broken down by route within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-route-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-route-stats-sort" + }, + { + "$ref": "#/components/parameters/api-insights-api-route-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-route-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-route-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/subject-stats": { + "get": { + "summary": "Get subject stats", + "description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-subject-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-sort" + }, + { + "$ref": "#/components/parameters/api-insights-subject-name-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-subject-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-subject-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/summary-stats": { + "get": { + "summary": "Get summary stats", + "description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + "get": { + "summary": "Get summary stats by user", + "description": "Get overall statistics of API requests within the organization for a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get summary stats by actor", + "description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/time-stats": { + "get": { + "summary": "Get time stats", + "description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + "get": { + "summary": "Get time stats by user", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get time stats by actor", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/insights/api/user-stats/{user_id}": { + "get": { + "summary": "Get user stats", + "description": "Get API usage statistics within an organization for a user broken down by the type of access.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-user-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-sort" + }, + { + "$ref": "#/components/parameters/api-insights-actor-name-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-user-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-user-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + }, + "x-octokit": {} + } + }, "/orgs/{org}/installation": { "get": { "summary": "Get an organization installation for the authenticated app", @@ -16973,7 +21524,7 @@ "/orgs/{org}/invitations": { "get": { "summary": "List pending organization invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.", + "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud\nmember, the `login` field in the return hash will be `null`.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], @@ -17063,7 +21614,7 @@ }, "post": { "summary": "Create an organization invitation", - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "tags": [ "orgs" ], @@ -17163,7 +21714,7 @@ "/orgs/{org}/invitations/{invitation_id}": { "delete": { "summary": "Cancel an organization invitation", - "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).", "tags": [ "orgs" ], @@ -17204,7 +21755,7 @@ "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { "summary": "List organization invitation teams", - "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", + "description": "List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.\n\nThis endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users).", "tags": [ "orgs" ], @@ -17267,7 +21818,7 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -17754,7 +22305,7 @@ "/orgs/{org}/members/{username}/copilot": { "get": { "summary": "Get Copilot seat assignment details for a user", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners can view GitHub Copilot seat assignment details for members in their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -17865,7 +22416,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -18467,7 +23018,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "organization-roles" @@ -18478,7 +23029,7 @@ "/orgs/{org}/organization-roles": { "get": { "summary": "Get all organization roles for an organization", - "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18538,7 +23089,7 @@ }, "post": { "summary": "Create a custom organization role", - "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo include repository permissions in an organization role, you must also include the `base_role`\nfield, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.\n\nSee \"[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" for valid repository permissions.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18557,28 +23108,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the custom role." - }, - "description": { - "type": "string", - "description": "A short description about the intended usage of this role or what permissions it grants." - }, - "permissions": { - "type": "array", - "description": "A list of additional permissions included in this role.", - "items": { - "type": "string" - } - } - }, - "required": [ - "name", - "permissions" - ] + "$ref": "#/components/schemas/organization-custom-organization-role-create-schema" }, "examples": { "default": { @@ -18650,7 +23180,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "organization-roles" @@ -18661,7 +23191,7 @@ "/orgs/{org}/organization-roles/teams/{team_slug}": { "delete": { "summary": "Remove all organization roles for a team", - "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18695,7 +23225,7 @@ "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { "put": { "summary": "Assign an organization role to a team", - "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18736,7 +23266,7 @@ }, "delete": { "summary": "Remove an organization role from a team", - "description": "Removes an organization role from a team. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18773,7 +23303,7 @@ "/orgs/{org}/organization-roles/users/{username}": { "delete": { "summary": "Remove all organization roles for a user", - "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18807,7 +23337,7 @@ "/orgs/{org}/organization-roles/users/{username}/{role_id}": { "put": { "summary": "Assign an organization role to a user", - "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18848,7 +23378,7 @@ }, "delete": { "summary": "Remove an organization role from a user", - "description": "Remove an organization role from a user. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18885,7 +23415,7 @@ "/orgs/{org}/organization-roles/{role_id}": { "get": { "summary": "Get an organization role", - "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18935,7 +23465,7 @@ }, "patch": { "summary": "Update a custom organization role", - "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nIf the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either\npreviously or as part of the update.\nIf the update sets the `base_role` field to `none`, you must also remove all of the repository\npermissions as well, otherwise the update will fail.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -18957,24 +23487,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the custom role." - }, - "description": { - "type": "string", - "description": "A short description about the intended usage of this role or what permissions it grants." - }, - "permissions": { - "type": "array", - "description": "A list of additional permissions included in this role.", - "items": { - "type": "string" - } - } - } + "$ref": "#/components/schemas/organization-custom-organization-role-update-schema" }, "examples": { "default": { @@ -19039,7 +23552,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "organization-roles" @@ -19071,7 +23584,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "orgs", "subcategory": "organization-roles" @@ -19082,7 +23595,7 @@ "/orgs/{org}/organization-roles/{role_id}/teams": { "get": { "summary": "List teams that are assigned to an organization role", - "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -19114,7 +23627,7 @@ "type": "array", "description": "List of teams assigned to the organization role", "items": { - "$ref": "#/components/schemas/team" + "$ref": "#/components/schemas/team-role-assignment" } }, "examples": { @@ -19149,7 +23662,7 @@ "/orgs/{org}/organization-roles/{role_id}/users": { "get": { "summary": "List users that are assigned to an organization role", - "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -19181,7 +23694,7 @@ "type": "array", "description": "List of users assigned to the organization role", "items": { - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/user-role-assignment" } }, "examples": { @@ -19431,7 +23944,7 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19524,7 +24037,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19571,7 +24084,7 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19617,7 +24130,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19672,7 +24185,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19763,7 +24276,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19813,7 +24326,7 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19862,7 +24375,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -20582,6 +25095,462 @@ "x-octokit": {} } }, + "/orgs/{org}/private-registries": { + "get": { + "summary": "List private registries for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/list-org-private-registries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#list-private-registries-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-private-registry-configuration" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configurations-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/create-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository" + ] + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": "string", + "nullable": true + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + }, + "required": [ + "registry_type", + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration" + }, + "org-private-registry-with-private-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/private-registries-public-key" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configuration" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository" + ] + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": "string", + "nullable": true + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a private registry for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/delete-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + }, + "x-octokit": {} + } + }, "/orgs/{org}/projects": { "get": { "summary": "List organization projects", @@ -20769,12 +25738,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" } }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" } } } @@ -20822,7 +25791,7 @@ "type": "array", "description": "The array of custom properties to create or update.", "items": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "minItems": 1, "maxItems": 100 @@ -20872,12 +25841,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" } }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-properties" + "$ref": "#/components/examples/custom-properties" } } } @@ -20925,11 +25894,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" } } } @@ -20974,55 +25943,7 @@ "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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "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", - "maxLength": 75 - }, - "maxItems": 200, - "nullable": true, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - } - }, - "required": [ - "value_type" - ] + "$ref": "#/components/schemas/custom-property-set-payload" }, "examples": { "default": { @@ -21047,11 +25968,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "examples": { "default": { - "$ref": "#/components/examples/org-custom-property" + "$ref": "#/components/examples/custom-property" } } } @@ -21422,7 +26343,7 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], @@ -21640,7 +26561,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -21650,7 +26571,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -21667,7 +26588,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -21817,6 +26738,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -21883,12 +26807,14 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", - "push" - ] + "push", + "repository" + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -22007,6 +26933,9 @@ { "$ref": "#/components/parameters/org" }, + { + "$ref": "#/components/parameters/ref-in-query" + }, { "$ref": "#/components/parameters/repository-name-in-query" }, @@ -22113,7 +27042,7 @@ "/orgs/{org}/rulesets/{ruleset_id}": { "get": { "summary": "Get an organization repository ruleset", - "description": "Get a repository ruleset for an organization.", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], @@ -22212,11 +27141,12 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -22405,6 +27335,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" } ], "responses": { @@ -22553,7 +27489,7 @@ "/orgs/{org}/security-managers": { "get": { "summary": "List security manager teams", - "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], @@ -22592,15 +27528,18 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "security-managers" + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" }, + "deprecated": true, "x-octokit": {} } }, "/orgs/{org}/security-managers/teams/{team_slug}": { "put": { "summary": "Add a security manager team", - "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], @@ -22620,9 +27559,6 @@ "responses": { "204": { "description": "Response" - }, - "409": { - "description": "The organization has reached the maximum number of security manager teams." } }, "x-github": { @@ -22630,13 +27566,16 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "security-managers" + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Remove a security manager team", - "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)\" endpoints instead.", "tags": [ "orgs" ], @@ -22663,8 +27602,11 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "security-managers" + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" }, + "deprecated": true, "x-octokit": {} } }, @@ -22916,10 +27858,101 @@ "x-octokit": {} } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + }, + "x-octokit": {} + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", - "description": "**Note**: This endpoint is in beta and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n**Note**: This endpoint will only return results for a given day if the team had five or more members on that day.\n\nCopilot Business or Copilot Enterprise organization owners for the organization that contains this team,\nand owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day.\n\nOrganization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -23129,7 +28162,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push" @@ -23194,7 +28227,7 @@ "/orgs/{org}/teams/{team_slug}": { "get": { "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Cloud replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Cloud replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -23241,7 +28274,7 @@ }, "patch": { "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -23291,7 +28324,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -23370,7 +28403,7 @@ }, "delete": { "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -23404,7 +28437,7 @@ "/orgs/{org}/teams/{team_slug}/discussions": { "get": { "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23474,7 +28507,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23558,7 +28591,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23605,7 +28638,7 @@ }, "patch": { "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23679,7 +28712,7 @@ }, "delete": { "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23716,7 +28749,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23780,7 +28813,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23856,7 +28889,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23906,7 +28939,7 @@ }, "patch": { "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23982,7 +29015,7 @@ }, "delete": { "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -24022,7 +29055,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -24105,7 +29138,7 @@ }, "post": { "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -24208,7 +29241,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -24251,7 +29284,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -24331,7 +29364,7 @@ }, "post": { "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -24431,7 +29464,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -24620,7 +29653,7 @@ "/orgs/{org}/teams/{team_slug}/invitations": { "get": { "summary": "List pending team invitations", - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", "tags": [ "teams" ], @@ -24755,7 +29788,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", "tags": [ "teams" ], @@ -24805,7 +29838,7 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using 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.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using 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.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], @@ -24887,7 +29920,7 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using 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.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using 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.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], @@ -24927,7 +29960,7 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "tags": [ "teams" ], @@ -24987,7 +30020,7 @@ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -25037,7 +30070,7 @@ }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -25128,7 +30161,7 @@ }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -25165,7 +30198,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], @@ -25225,7 +30258,7 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], @@ -25281,7 +30314,7 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], @@ -25313,8 +30346,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "default": "push" + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." } } }, @@ -25344,7 +30376,7 @@ }, "delete": { "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], @@ -25384,7 +30416,7 @@ "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { "get": { "summary": "List IdP groups for a team", - "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\n\nTeam synchronization is available for organizations using 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.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "description": "List IdP groups connected to a team on GitHub Enterprise Cloud.\n\nTeam synchronization is available for organizations using 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.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], @@ -25428,7 +30460,7 @@ }, "patch": { "summary": "Create or update IdP group connections", - "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.\n\nTeam synchronization is available for organizations using 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.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", + "description": "Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.\n\nTeam synchronization is available for organizations using 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.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`.", "tags": [ "teams" ], @@ -25526,7 +30558,7 @@ "/orgs/{org}/teams/{team_slug}/teams": { "get": { "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], @@ -25586,7 +30618,7 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], @@ -25643,8 +30675,11 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "orgs" + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" }, + "deprecated": true, "x-octokit": {} } }, @@ -27189,7 +32224,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -27245,7 +32280,7 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], @@ -27383,6 +32418,26 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, "secret_scanning_validity_checks": { "type": "object", "description": "Use the `status` property to enable or disable secret scanning automatic validity checks on supported partner tokens for this repository.", @@ -27451,7 +32506,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -27461,7 +32516,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -27478,7 +32533,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -29573,7 +34628,7 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. 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/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. 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/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], @@ -30177,7 +35232,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], @@ -31661,7 +36716,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs for a workflow", - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. 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/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], @@ -32041,6 +37096,208 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/attestations": { + "post": { + "summary": "Create an attestation", + "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "repos" + ], + "operationId": "repos/create-attestation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + } + }, + "required": [ + "bundle" + ] + }, + "examples": { + "default": { + "summary": "Example of a request body", + "value": { + "$ref": "#/components/examples/attestation" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the attestation." + } + } + }, + "examples": { + "default": { + "value": { + "id": 2 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "repos" + ], + "operationId": "repos/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/autolinks": { "get": { "summary": "Get all autolinks of a repository", @@ -32295,7 +37552,7 @@ ], "responses": { "200": { - "description": "Response if dependabot is enabled", + "description": "Response if Dependabot is enabled", "content": { "application/json": { "schema": { @@ -32313,7 +37570,7 @@ } }, "404": { - "description": "Not Found if dependabot is not enabled for the repository" + "description": "Not Found if Dependabot is not enabled for the repository" } }, "x-github": { @@ -32410,7 +37667,7 @@ }, { "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "description": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", "required": false, "schema": { @@ -32569,7 +37826,7 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], @@ -32608,7 +37865,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -33106,7 +38363,7 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], @@ -33311,7 +38568,7 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], @@ -33535,7 +38792,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -34016,7 +39273,7 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. 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.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], @@ -34177,32 +39434,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -34271,32 +39524,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -34365,31 +39614,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -34852,32 +40098,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -34947,32 +40189,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -35042,31 +40280,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -35117,7 +40352,7 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], @@ -35198,6 +40433,141 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/bypass-requests/push-rules": { + "get": { + "summary": "List repository push rule bypass requests", + "description": "Lists the requests made by users of a repository to bypass push protection rules", + "tags": [ + "repos" + ], + "operationId": "repos/list-repo-push-bypass-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#list-repository-push-rule-bypass-requests" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "bypass-requests" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/bypass-reviewer-name" + }, + { + "$ref": "#/components/parameters/bypass-requester-name" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/bypass-request-status" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/push-rule-bypass-request" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/push-rule-bypass-request-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": { + "get": { + "summary": "Get a repository push bypass request", + "description": "Get information about a request to bypass push protection rules for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-push-bypass-request", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/bypass-requests#get-a-repository-push-bypass-request" + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "bypass-requests" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "bypass_request_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "description": "The number that identifies the bypass request within the context of the given repository.", + "example": 1 + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/push-rule-bypass-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/push-rule-bypass-request-item" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/check-runs": { "post": { "summary": "Create a check run", @@ -35519,7 +40889,7 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}": { "get": { "summary": "Get a check run", - "description": "Gets a single check run using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -35566,7 +40936,7 @@ }, "patch": { "summary": "Update a check run", - "description": "Updates a check run for a specific commit in a 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -36014,7 +41384,7 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -36193,7 +41563,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { "get": { "summary": "Get a check suite", - "description": "Gets a single check suite using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -36242,7 +41612,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "Lists check runs for a check suite using its `id`.\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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -36417,9 +41787,18 @@ { "$ref": "#/components/parameters/git-ref" }, + { + "$ref": "#/components/parameters/pr-alias" + }, { "$ref": "#/components/parameters/direction" }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, { "name": "sort", "description": "The property by which to sort the results.", @@ -36655,6 +42034,223 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + "get": { + "summary": "Get the status of an autofix for a code scanning alert", + "description": "Gets the status and description of an autofix for a code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an autofix for a code scanning alert", + "description": "Creates an autofix for a code scanning alert.\n\nIf a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.\n\nIf an autofix already exists for a given alert, then this endpoint will return a 200 OK response.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/create-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix" + } + } + } + } + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-pending" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_autofix_create_forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + "post": { + "summary": "Commit an autofix for a code scanning alert", + "description": "Commits an autofix for a code scanning alert.\n\nIf an autofix is commited as a result of this request, then this endpoint will return a 201 Created response.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/commit-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix-commits" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-commits" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix-commits-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-commits-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { "get": { "summary": "List instances of a code scanning alert", @@ -36685,6 +42281,9 @@ }, { "$ref": "#/components/parameters/git-ref" + }, + { + "$ref": "#/components/parameters/pr-alias" } ], "responses": { @@ -36738,7 +42337,7 @@ "/repos/{owner}/{repo}/code-scanning/analyses": { "get": { "summary": "List code scanning analyses for a repository", - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/list-recent-analyses", "tags": [ "code-scanning" @@ -36766,6 +42365,9 @@ { "$ref": "#/components/parameters/per-page" }, + { + "$ref": "#/components/parameters/pr-alias" + }, { "name": "ref", "in": "query", @@ -36992,7 +42594,7 @@ "/repos/{owner}/{repo}/code-scanning/codeql/databases": { "get": { "summary": "List CodeQL databases for a repository", - "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], @@ -37051,7 +42653,7 @@ "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { "get": { "summary": "Get a CodeQL database for a repository", - "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], @@ -37114,6 +42716,380 @@ "subcategory": "code-scanning" }, "x-octokit": {} + }, + "delete": { + "summary": "Delete a CodeQL database", + "description": "Deletes a CodeQL database for a language in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/delete-codeql-database", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "language", + "in": "path", + "description": "The language of the CodeQL database.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + "post": { + "summary": "Create a CodeQL variant analysis", + "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/create-variant-analysis", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#create-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "language": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-language" + }, + "query_pack": { + "description": "A Base64-encoded tarball containing a CodeQL query and all its dependencies", + "type": "string" + }, + "repositories": { + "type": "array", + "description": "List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "items": { + "type": "string" + } + }, + "repository_lists": { + "description": "List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "repository_owners": { + "description": "List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "language", + "query_pack" + ], + "oneOf": [ + { + "required": [ + "repositories" + ] + }, + { + "required": [ + "repository_lists" + ] + }, + { + "required": [ + "repository_owners" + ] + } + ] + }, + "examples": { + "repositories_parameter": { + "summary": "Using the \"repositories\" field. \"query_pack\" is abridged for brevity.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repositories": [ + "octocat/Hello-World", + "octocat/example" + ] + } + }, + "repository_owners": { + "summary": "Using the \"repository_owners\" field. \"query_pack\" is abridged.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repository_owners": [ + "octocat" + ] + } + }, + "repository_lists": { + "summary": "Using the \"repository_lists\" field. \"query_pack\" is abridged.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repository_lists": [ + "top-100-csharp" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Variant analysis submitted for processing", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis" + }, + "examples": { + "repositories_parameter": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + }, + "repository_owners": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + }, + "repository_lists": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unable to process variant analysis submission", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + "get": { + "summary": "Get the summary of a CodeQL variant analysis", + "description": "Gets the summary of a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-variant-analysis", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "codeql_variant_analysis_id", + "in": "path", + "description": "The unique identifier of the variant analysis.", + "schema": { + "type": "integer" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + "get": { + "summary": "Get the analysis status of a repository in a CodeQL variant analysis", + "description": "Gets the analysis status of a repository in a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-variant-analysis-repo-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "name": "repo", + "in": "path", + "description": "The name of the controller repository.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "codeql_variant_analysis_id", + "in": "path", + "description": "The ID of the variant analysis.", + "schema": { + "type": "integer" + }, + "required": true + }, + { + "name": "repo_owner", + "in": "path", + "description": "The account owner of the variant analysis repository. The name is not case sensitive.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "repo_name", + "in": "path", + "description": "The name of the variant analysis repository.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repo-task" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-variant-analysis-repo-task" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + }, + "x-octokit": {} } }, "/repos/{owner}/{repo}/code-scanning/default-setup": { @@ -37260,7 +43236,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -37437,6 +43413,64 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/code-security-configuration": { + "get": { + "summary": "Get the code security configuration associated with a repository", + "description": "Get the code security configuration that manages a repository's code security settings.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configuration-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-for-repository" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/codeowners/errors": { "get": { "summary": "List CODEOWNERS errors", @@ -37610,7 +43644,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -38168,7 +44202,7 @@ "/repos/{owner}/{repo}/codespaces/secrets/public-key": { "get": { "summary": "Get a repository public key", - "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "codespaces" ], @@ -38509,7 +44543,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "tags": [ "repos" ], @@ -38591,7 +44625,7 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n**Note**: A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], @@ -39098,7 +45132,7 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], @@ -39138,7 +45172,7 @@ "/repos/{owner}/{repo}/commits": { "get": { "summary": "List commits", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -39191,11 +45225,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -39378,7 +45419,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -39419,7 +45460,7 @@ }, "line": { "type": "integer", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." + "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ @@ -39549,7 +45590,7 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -39619,7 +45660,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -39722,7 +45763,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -39980,7 +46021,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -40119,7 +46160,16 @@ { "$ref": "#/components/schemas/content-submodule" } - ] + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "array": "#/components/schemas/content-directory", + "file": "#/components/schemas/content-file", + "symlink": "#/components/schemas/content-symlink", + "submodule": "#/components/schemas/content-submodule" + } + } }, "examples": { "response-if-content-is-a-file": { @@ -40141,6 +46191,9 @@ "302": { "$ref": "#/components/responses/found" }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -40158,7 +46211,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], @@ -40321,7 +46374,21 @@ "$ref": "#/components/responses/not_found" }, "409": { - "$ref": "#/components/responses/conflict" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/basic-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } }, "422": { "$ref": "#/components/responses/validation_failed" @@ -40337,7 +46404,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -40593,7 +46660,7 @@ }, { "name": "page", - "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", "deprecated": true, "in": "query", "schema": { @@ -41797,7 +47864,7 @@ }, "target_url": { "type": "string", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.", "default": "" }, "log_url": { @@ -41976,7 +48043,7 @@ }, "client_payload": { "type": "object", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.", "additionalProperties": true, "maxProperties": 10 } @@ -42084,7 +48151,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}": { "get": { "summary": "Get an environment", - "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], @@ -42131,7 +48198,7 @@ }, "put": { "summary": "Create or update an environment", - "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], @@ -42769,7 +48836,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { "get": { "summary": "List custom deployment rule integrations available for an environment", - "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], @@ -43537,7 +49604,7 @@ "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", - "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -43669,7 +49736,7 @@ }, "post": { "summary": "Create a fork", - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", + "description": "Create a fork for the authenticated user.\n\n> [!NOTE]\n> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", "tags": [ "repos" ], @@ -43844,7 +49911,21 @@ "$ref": "#/components/responses/conflict" }, "422": { - "$ref": "#/components/responses/validation_failed" + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } } }, "x-github": { @@ -43925,7 +50006,7 @@ "/repos/{owner}/{repo}/git/commits": { "post": { "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -43959,7 +50040,7 @@ }, "parents": { "type": "array", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", "items": { "type": "string" } @@ -44082,7 +50163,7 @@ "/repos/{owner}/{repo}/git/commits/{commit_sha}": { "get": { "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -44137,7 +50218,7 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], @@ -44197,7 +50278,7 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], @@ -44472,7 +50553,7 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -44609,7 +50690,7 @@ "/repos/{owner}/{repo}/git/tags/{tag_sha}": { "get": { "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -44737,7 +50818,7 @@ }, "base_tree": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n" + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." } }, "required": [ @@ -44811,7 +50892,7 @@ "/repos/{owner}/{repo}/git/trees/{tree_sha}": { "get": { "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", "tags": [ "git" ], @@ -45237,7 +51318,7 @@ }, "delete": { "summary": "Delete a repository webhook", - "description": "", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", "tags": [ "repos" ], @@ -45431,14 +51512,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -45623,7 +51696,7 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { "post": { "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", "tags": [ "repos" ], @@ -45663,7 +51736,7 @@ "/repos/{owner}/{repo}/import": { "get": { "summary": "Get an import status", - "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.", + "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -45716,7 +51789,7 @@ }, "put": { "summary": "Start an import", - "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", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -45831,7 +51904,7 @@ }, "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:** 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).", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -45944,7 +52017,7 @@ }, "delete": { "summary": "Cancel an import", - "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", + "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -45984,7 +52057,7 @@ "/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:** 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).", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -46045,7 +52118,7 @@ "/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:** 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", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -46140,7 +52213,7 @@ "/repos/{owner}/{repo}/import/large_files": { "get": { "summary": "Get large files", - "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", + "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -46195,7 +52268,7 @@ "/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:** 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", + "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]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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" ], @@ -46663,7 +52736,7 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -46805,7 +52878,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -46846,7 +52919,7 @@ }, "assignee": { "type": "string", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_", "nullable": true }, "milestone": { @@ -47411,7 +53484,7 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], @@ -47577,7 +53650,7 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -47636,7 +53709,7 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -47683,7 +53756,7 @@ "assignee": { "type": "string", "nullable": true, - "description": "Username to assign to this issue. **This field is deprecated.**" + "description": "Username to assign to this issue. **This field is closing down.**" }, "state": { "type": "string", @@ -48103,7 +54176,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -48992,7 +55065,7 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], @@ -49029,17 +55102,17 @@ "x-octokit": {} } }, - "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - "get": { - "summary": "List timeline events for an issue", - "description": "List all timeline events for an issue.", + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + "delete": { + "summary": "Remove sub-issue", + "description": "You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], - "operationId": "issues/list-events-for-timeline", + "operationId": "issues/remove-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue" }, "parameters": [ { @@ -49050,65 +55123,86 @@ }, { "$ref": "#/components/parameters/issue-number" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sub_issue_id": { + "type": "integer", + "description": "The sub-issue to remove" + } + }, + "required": [ + "sub_issue_id" + ] + }, + "examples": { + "default": { + "value": { + "sub_issue_id": 6 + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/timeline-issue-events" - } + "$ref": "#/components/schemas/issue" }, "examples": { "default": { - "$ref": "#/components/examples/timeline-issue-events" + "$ref": "#/components/examples/issue" } } } }, "headers": { - "Link": { - "$ref": "#/components/headers/link" + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue", + "schema": { + "type": "string" + } } } }, + "400": { + "$ref": "#/components/responses/bad_request" + }, "404": { "$ref": "#/components/responses/not_found" - }, - "410": { - "$ref": "#/components/responses/gone" } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "issues", - "subcategory": "timeline" + "subcategory": "sub-issues" }, "x-octokit": {} } }, - "/repos/{owner}/{repo}/keys": { + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { "get": { - "summary": "List deploy keys", - "description": "", + "summary": "List sub-issues", + "description": "You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/list-deploy-keys", + "operationId": "issues/list-sub-issues", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues" }, "parameters": [ { @@ -49117,6 +55211,9 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/issue-number" + }, { "$ref": "#/components/parameters/per-page" }, @@ -49132,12 +55229,12 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/deploy-key" + "$ref": "#/components/schemas/issue" } }, "examples": { "default": { - "$ref": "#/components/examples/deploy-key-items" + "$ref": "#/components/examples/issue-items" } } } @@ -49147,26 +55244,32 @@ "$ref": "#/components/headers/link" } } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "sub-issues" }, "x-octokit": {} }, "post": { - "summary": "Create a deploy key", - "description": "You can create a read-only deploy key.", + "summary": "Add sub-issue", + "description": "You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/create-deploy-key", + "operationId": "issues/add-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue" }, "parameters": [ { @@ -49174,6 +55277,9 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" } ], "requestBody": { @@ -49183,29 +55289,23 @@ "schema": { "type": "object", "properties": { - "title": { - "type": "string", - "description": "A name for the key." - }, - "key": { - "type": "string", - "description": "The contents of the key." + "sub_issue_id": { + "type": "integer", + "description": "The sub-issue to add" }, - "read_only": { + "replace_parent": { "type": "boolean", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/).\"" + "description": "Option that, when true, instructs the operation to replace the sub-issues current parent issue" } }, "required": [ - "key" + "sub_issue_id" ] }, "examples": { "default": { "value": { - "title": "octocat@octomac", - "key": "ssh-rsa AAA...", - "read_only": true + "sub_issue_id": 1 } } } @@ -49218,24 +55318,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deploy-key" + "$ref": "#/components/schemas/issue" }, "examples": { "default": { - "$ref": "#/components/examples/deploy-key" + "$ref": "#/components/examples/issue" } } } }, "headers": { "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1", "schema": { "type": "string" } } } }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, "422": { "$ref": "#/components/responses/validation_failed" } @@ -49243,23 +55352,23 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "sub-issues" }, "x-octokit": {} } }, - "/repos/{owner}/{repo}/keys/{key_id}": { - "get": { - "summary": "Get a deploy key", - "description": "", + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + "patch": { + "summary": "Reprioritize sub-issue", + "description": "You can use the REST API to reprioritize a sub-issue to a different position in the parent list.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/get-deploy-key", + "operationId": "issues/reprioritize-sub-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue" }, "parameters": [ { @@ -49269,47 +55378,94 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/key-id" + "$ref": "#/components/parameters/issue-number" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sub_issue_id": { + "type": "integer", + "description": "The id of the sub-issue to reprioritize" + }, + "after_id": { + "type": "integer", + "description": "The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified)." + }, + "before_id": { + "type": "integer", + "description": "The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified)." + } + }, + "required": [ + "sub_issue_id" + ] + }, + "examples": { + "default": { + "value": { + "sub_issue_id": 6, + "after_id": 5 + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deploy-key" + "$ref": "#/components/schemas/issue" }, "examples": { "default": { - "$ref": "#/components/examples/deploy-key" + "$ref": "#/components/examples/issue" } } } } }, + "403": { + "$ref": "#/components/responses/forbidden" + }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "sub-issues" }, "x-octokit": {} - }, - "delete": { - "summary": "Delete a deploy key", - "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + "get": { + "summary": "List timeline events for an issue", + "description": "List all timeline events for an issue.", "tags": [ - "repos" + "issues" ], - "operationId": "repos/delete-deploy-key", + "operationId": "issues/list-events-for-timeline", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue" }, "parameters": [ { @@ -49319,34 +55475,304 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/key-id" + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/timeline-issue-events" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/timeline-issue-events" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "deploy-keys", - "subcategory": "deploy-keys" + "category": "issues", + "subcategory": "timeline" }, "x-octokit": {} } }, - "/repos/{owner}/{repo}/labels": { + "/repos/{owner}/{repo}/keys": { "get": { - "summary": "List labels for a repository", - "description": "Lists all labels for a repository.", + "summary": "List deploy keys", + "description": "", "tags": [ - "issues" + "repos" ], - "operationId": "issues/list-labels-for-repo", + "operationId": "repos/list-deploy-keys", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deploy-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a deploy key", + "description": "You can create a read-only deploy key.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "A name for the key." + }, + "key": { + "type": "string", + "description": "The contents of the key." + }, + "read_only": { + "type": "boolean", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/).\"" + } + }, + "required": [ + "key" + ] + }, + "examples": { + "default": { + "value": { + "title": "octocat@octomac", + "key": "ssh-rsa AAA...", + "read_only": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deploy-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/keys/{key_id}": { + "get": { + "summary": "Get a deploy key", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/get-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deploy-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a deploy key", + "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/labels": { + "get": { + "summary": "List labels for a repository", + "description": "Lists all labels for a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository" }, "parameters": [ { @@ -50818,7 +57244,7 @@ "properties": { "cname": { "type": "string", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//pages/configuring-a-custom-domain-for-your-github-pages-site).\"", "nullable": true }, "https_enforced": { @@ -52012,7 +58438,7 @@ }, "post": { "summary": "Create a pull request", - "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.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -52573,7 +58999,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction 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" ], @@ -52613,7 +59039,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get a pull request", - "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.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "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.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], @@ -52635,7 +59061,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -52809,7 +59235,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -52999,7 +59425,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -53040,7 +59466,7 @@ }, "position": { "type": "integer", - "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "deprecated": true, "x-github": { "deprecationDate": "2022-11-01" @@ -53152,7 +59578,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -53305,7 +59731,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -53415,7 +59841,7 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], @@ -53868,7 +60294,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -54269,7 +60695,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -54458,7 +60884,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { "put": { "summary": "Update a pull request branch", - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.", "tags": [ "pulls" ], @@ -54590,6 +61016,9 @@ } } }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "404": { "$ref": "#/components/responses/not_found" }, @@ -54741,7 +61170,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], @@ -54808,7 +61237,7 @@ "false", "legacy" ], - "default": true + "default": "true" } }, "required": [ @@ -54882,7 +61311,7 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], @@ -55246,7 +61675,7 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], @@ -55785,7 +62214,7 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release).", "tags": [ "reactions" ], @@ -55920,6 +62349,9 @@ "type": "boolean", "default": true } + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -55989,12 +62421,13 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", "push" - ] + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -56215,7 +62648,7 @@ "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { "get": { "summary": "Get a repository ruleset", - "description": "Get a ruleset for a repository.", + "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], @@ -56330,7 +62763,7 @@ }, "target": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", + "description": "The target of the ruleset", "enum": [ "branch", "tag", @@ -56519,6 +62952,12 @@ }, { "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" } ], "responses": { @@ -56775,6 +63214,146 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + "post": { + "summary": "Create a push protection bypass", + "description": "Creates a bypass for a previously push protected secret.\n\nThe authenticated user must be the original author of the committed secret.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "secret-scanning/create-push-protection-bypass", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + } + }, + "required": [ + "reason", + "placeholder_id" + ] + }, + "examples": { + "default": { + "value": { + "reason": "will_fix_later", + "placeholder_id": "2k4dM4tseyC5lPIsjl5emX9sPNk" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-push-protection-bypass" + } + } + } + } + }, + "403": { + "description": "User does not have enough permissions to perform this action." + }, + "404": { + "description": "Placeholder ID not found, or push protection is disabled on this repository." + }, + "422": { + "description": "Bad request, input data missing or incorrect." + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "secret-scanning", + "subcategory": "secret-scanning" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + "get": { + "summary": "Get secret scanning scan history for a repository", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/get-scan-history", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-scan-history" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-scan-history" + } + } + } + } + }, + "404": { + "description": "Repository does not have GitHub Advanced Security or secret scanning enabled" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/security-advisories": { "get": { "summary": "List repository security advisories", @@ -57373,7 +63952,7 @@ "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { "post": { "summary": "Create a temporary private fork", - "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n**Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.", + "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n> [!NOTE]\n> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.", "tags": [ "security-advisories" ], @@ -57510,7 +64089,7 @@ "/repos/{owner}/{repo}/stats/code_frequency": { "get": { "summary": "Get the weekly commit activity", - "description": "\nReturns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n**Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains\n10,000 or more commits, a 422 status code will be returned.\n", + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n> [!NOTE]\n> This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.", "tags": [ "repos" ], @@ -57623,7 +64202,7 @@ "/repos/{owner}/{repo}/stats/contributors": { "get": { "summary": "Get all contributor commit activity", - "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n**Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.", + "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n> [!NOTE]\n> This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.", "tags": [ "repos" ], @@ -58167,15 +64746,15 @@ }, "/repos/{owner}/{repo}/tags/protection": { "get": { - "summary": "List tag protection states for a repository", - "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", + "summary": "Closing down - List tag protection states for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/list-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#list-tag-protection-states-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository" }, "parameters": [ { @@ -58215,20 +64794,23 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} }, "post": { - "summary": "Create a tag protection state for a repository", - "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Create a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/create-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#create-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -58291,22 +64873,25 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { "delete": { - "summary": "Delete a tag protection state for a repository", - "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Delete a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/delete-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#delete-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -58334,15 +64919,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tarball/{ref}": { "get": { "summary": "Download a repository archive (tar)", - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", "tags": [ "repos" ], @@ -58545,7 +65133,7 @@ "properties": { "names": { "type": "array", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.", "items": { "type": "string" } @@ -59002,7 +65590,7 @@ "/repos/{owner}/{repo}/zipball/{ref}": { "get": { "summary": "Download a repository archive (zip)", - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "tags": [ "repos" ], @@ -59167,7 +65755,7 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "repos", "subcategory": "repos" }, @@ -59237,7 +65825,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "Lists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -59320,7 +65908,7 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nCreates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", + "description": "Creates a SCIM group for an enterprise.\n\nWhen members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" @@ -59402,7 +65990,7 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nGets information about a SCIM group.", + "description": "Gets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" @@ -59467,7 +66055,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "Replaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" @@ -59577,7 +66165,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n**Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here.", + "description": "Update a provisioned group’s individual attributes.\n\nTo modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships.\n\nYou can submit group memberships individually or in batches for improved efficiency.\n\n> [!NOTE]\n> Memberships are referenced via a local user id. Ensure users are created before referencing them here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" @@ -59697,7 +66285,7 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "**Note:** SCIM provisioning using the REST API is in public beta and subject to change.\n\nDeletes a SCIM group from an enterprise.", + "description": "Deletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" @@ -59749,7 +66337,7 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", + "description": "Lists provisioned SCIM enterprise members.\n\nWhen you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" @@ -59828,7 +66416,7 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", + "description": "Creates an external identity for a new SCIM enterprise user.\n\nSCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" @@ -59910,7 +66498,7 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nGets information about a SCIM user.", + "description": "Gets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" @@ -59972,7 +66560,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", + "description": "Replaces an existing provisioned user's information.\n\nYou must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" @@ -60052,7 +66640,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "**Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n**Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "description": "Update a provisioned user's individual attributes.\n\nTo modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will be ineffective.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user, and their handle and email will be obfuscated.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" @@ -60190,7 +66778,7 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "**Note:** SCIM provisioning using the REST API is in public beta and subject to change.\n\nSuspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", + "description": "Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" @@ -60502,7 +67090,7 @@ "/scim/v2/organizations/{org}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for a user", - "description": "", + "description": "Gets SCIM provisioning information for a user.", "tags": [ "scim" ], @@ -60555,7 +67143,7 @@ }, "put": { "summary": "Update a provisioned organization membership", - "description": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n**Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`.", + "description": "Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n> [!WARNING]\n> Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`.", "tags": [ "scim" ], @@ -60721,7 +67309,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM user", - "description": "Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "description": "Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n> [!WARNING]\n> If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "tags": [ "scim" ], @@ -60900,7 +67488,7 @@ }, "delete": { "summary": "Delete a SCIM user from an organization", - "description": "", + "description": "Deletes a SCIM user from an organization.", "tags": [ "scim" ], @@ -60965,7 +67553,7 @@ { "name": "sort", "deprecated": true, - "description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", + "description": "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -60977,7 +67565,7 @@ }, { "name": "order", - "description": "**This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ", + "description": "**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ", "in": "query", "deprecated": true, "required": false, @@ -61150,7 +67738,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], @@ -61650,7 +68238,7 @@ "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], @@ -61697,7 +68285,7 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], @@ -61744,7 +68332,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -61829,7 +68417,7 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], @@ -61869,7 +68457,7 @@ "/teams/{team_id}/discussions": { "get": { "summary": "List discussions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -61930,7 +68518,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62014,7 +68602,7 @@ "/teams/{team_id}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62061,7 +68649,7 @@ }, "patch": { "summary": "Update a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62135,7 +68723,7 @@ }, "delete": { "summary": "Delete a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62172,7 +68760,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62236,7 +68824,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62312,7 +68900,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62362,7 +68950,7 @@ }, "patch": { "summary": "Update a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62438,7 +69026,7 @@ }, "delete": { "summary": "Delete a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -62478,7 +69066,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -62561,7 +69149,7 @@ }, "post": { "summary": "Create reaction for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -62649,7 +69237,7 @@ "/teams/{team_id}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -62729,7 +69317,7 @@ }, "post": { "summary": "Create reaction for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -62814,7 +69402,7 @@ "/teams/{team_id}/invitations": { "get": { "summary": "List pending team invitations (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`.", "tags": [ "teams" ], @@ -62874,7 +69462,7 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], @@ -62952,7 +69540,7 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], @@ -62990,7 +69578,7 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using 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.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using 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.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], @@ -63034,7 +69622,7 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], @@ -63074,7 +69662,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team).", "tags": [ "teams" ], @@ -63124,7 +69712,7 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], @@ -63209,7 +69797,7 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], @@ -63249,7 +69837,7 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "tags": [ "teams" ], @@ -63312,7 +69900,7 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "tags": [ "teams" ], @@ -63362,7 +69950,7 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", "tags": [ "teams" ], @@ -63458,7 +70046,7 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", "tags": [ "teams" ], @@ -63501,7 +70089,7 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], @@ -63564,7 +70152,7 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], @@ -63620,7 +70208,7 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], @@ -63693,7 +70281,7 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], @@ -63733,7 +70321,7 @@ "/teams/{team_id}/team-sync/group-mappings": { "get": { "summary": "List IdP groups for a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nList IdP groups connected to a team on GitHub Enterprise Cloud.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nList IdP groups connected to a team on GitHub Enterprise Cloud.", "tags": [ "teams" ], @@ -63783,7 +70371,7 @@ }, "patch": { "summary": "Create or update IdP group connections (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint.\n\nTeam synchronization is available for organizations using 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.\n\nCreates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team.", "tags": [ "teams" ], @@ -63906,7 +70494,7 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], @@ -63998,7 +70586,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "response-with-public-and-private-profile-information": { @@ -64462,7 +71057,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -64534,7 +71129,7 @@ "type": "string" }, "geo": { - "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated.", + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", "type": "string", "enum": [ "EuropeWest", @@ -65965,9 +72560,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 + "example": "username@example.com" }, + "minItems": 1, "example": [] } }, @@ -66077,9 +72672,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 - } + "example": "username@example.com" + }, + "minItems": 1 } }, "example": { @@ -66363,6 +72958,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -66862,7 +73460,7 @@ "/user/installations/{installation_id}/repositories/{repository_id}": { "put": { "summary": "Add a repository to an app installation", - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], @@ -66913,7 +73511,7 @@ }, "delete": { "summary": "Remove a repository from an app installation", - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], @@ -67130,7 +73728,7 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -68330,7 +74928,7 @@ "/user/orgs": { "get": { "summary": "List organizations for the authenticated user", - "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.", "tags": [ "orgs" ], @@ -68393,7 +74991,7 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -68465,7 +75063,7 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -68509,7 +75107,7 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -68552,7 +75150,7 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -68604,7 +75202,7 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -68692,7 +75290,7 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -68739,7 +75337,7 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -68785,7 +75383,7 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -69242,7 +75840,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -69259,7 +75857,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -70364,6 +76962,69 @@ "x-octokit": {} } }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails)\".", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + }, + "x-octokit": {} + } + }, "/users": { "get": { "summary": "List users", @@ -70454,7 +77115,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "default-response": { @@ -70480,6 +77148,108 @@ "x-octokit": {} } }, + "/users/{username}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/users/attestations#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "$ref": "#/components/schemas/sigstore-bundle-0" + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + }, + "x-octokit": {} + } + }, "/users/{username}/docker/conflicts": { "get": { "summary": "Get list of conflicting packages during Docker migration for user", @@ -70535,7 +77305,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -70587,7 +77357,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -70642,7 +77412,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71200,7 +77970,7 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71281,7 +78051,7 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71328,7 +78098,7 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71374,7 +78144,7 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71429,7 +78199,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by a user", - "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71490,7 +78260,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71540,7 +78310,7 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71589,7 +78359,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -71713,7 +78483,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71765,7 +78535,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -72919,13 +79689,13 @@ } } }, - "check-run-completed": { + "bypass-request-push-ruleset-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", - "operationId": "check-run/completed", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "description": "A push ruleset bypass request was cancelled.", + "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -72990,22 +79760,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -73016,10 +79771,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -73028,13 +79782,13 @@ } } }, - "check-run-created": { + "bypass-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", - "operationId": "check-run/created", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "description": "A push ruleset bypass request was completed.", + "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -73099,22 +79853,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -73125,10 +79864,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -73137,13 +79875,13 @@ } } }, - "check-run-requested-action": { + "bypass-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", - "operationId": "check-run/requested-action", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "description": "A push ruleset bypass request was created.", + "operationId": "exemption-request-push-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -73208,22 +79946,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -73234,10 +79957,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -73246,13 +79968,13 @@ } } }, - "check-run-rerequested": { + "bypass-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", - "operationId": "check-run/rerequested", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "description": "A push ruleset bypass response was dismissed.", + "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -73317,22 +80039,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -73343,10 +80050,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -73355,13 +80061,13 @@ } } }, - "check-suite-completed": { + "bypass-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", + "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_push_ruleset" }, "parameters": [ { @@ -73426,7 +80132,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -73437,9 +80143,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "bypass_request_push_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -73448,13 +80154,13 @@ } } }, - "check-suite-requested": { + "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", - "operationId": "check-suite/requested", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -73519,7 +80225,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } @@ -73530,9 +80236,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -73541,13 +80247,13 @@ } } }, - "check-suite-rerequested": { + "bypass-request-secret-scanning-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", - "operationId": "check-suite/rerequested", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -73612,7 +80318,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -73623,9 +80329,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -73634,13 +80340,13 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "bypass-request-secret-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -73705,7 +80411,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -73716,9 +80422,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -73727,13 +80433,13 @@ } } }, - "code-scanning-alert-closed-by-user": { + "bypass-request-secret-scanning-response-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -73798,7 +80504,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -73809,9 +80515,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -73820,13 +80526,13 @@ } } }, - "code-scanning-alert-created": { + "bypass-request-secret-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -73891,7 +80597,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -73902,9 +80608,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -73913,13 +80619,13 @@ } } }, - "code-scanning-alert-fixed": { + "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -73984,100 +80690,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "code_scanning_alert", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "code-scanning-alert-reopened": { - "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" - }, - "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": { + }, + "application/x-www-form-urlencoded": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } } } } @@ -74089,8 +80717,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -74099,13 +80728,13 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", + "operationId": "check-run/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -74170,7 +80799,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } } } } @@ -74182,8 +80826,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -74192,13 +80837,13 @@ } } }, - "commit-comment-created": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-cloud@latest//developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -74263,7 +80908,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } } } } @@ -74275,8 +80935,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "commit_comment", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -74285,12 +80946,13 @@ } } }, - "create": { + "check-run-rerequested": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", - "operationId": "create", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -74355,7 +81017,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-check-run-rerequested" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested-form-encoded" + } } } } @@ -74367,8 +81044,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "create", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -74377,13 +81055,13 @@ } } }, - "custom-property-created": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A new custom property was created.", - "operationId": "custom-property/created", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -74448,191 +81126,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "organization", - "app" - ] - } - } - }, - "custom-property-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was deleted.", - "operationId": "custom-property/deleted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "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-custom-property-deleted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "custom_property", - "supported-webhook-types": [ - "organization", - "app" - ] - } - } - }, - "custom-property-updated": { - "post": { - "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "A custom property was updated.", - "operationId": "custom-property/updated", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" - }, - "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-custom-property-updated" + "$ref": "#/components/schemas/webhook-check-suite-completed" } } } @@ -74645,21 +81139,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom_property", + "subcategory": "check_suite", "supported-webhook-types": [ + "repository", "organization", "app" ] } } }, - "custom-property-values-updated": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", - "description": "The custom property values of a repository were updated.", - "operationId": "custom-property-values/updated", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -74724,7 +81219,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-check-suite-requested" } } } @@ -74737,7 +81232,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "custom-property-values", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -74746,12 +81241,13 @@ } } }, - "delete": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-cloud@latest//graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -74816,7 +81312,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-check-suite-rerequested" } } } @@ -74829,7 +81325,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -74838,13 +81334,13 @@ } } }, - "dependabot-alert-auto-dismissed": { + "code-scanning-alert-appeared-in-branch": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", - "operationId": "dependabot-alert/auto-dismissed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -74909,7 +81405,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" } } } @@ -74922,7 +81418,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -74931,13 +81427,13 @@ } } }, - "dependabot-alert-auto-reopened": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", - "operationId": "dependabot-alert/auto-reopened", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -75002,7 +81498,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" } } } @@ -75015,7 +81511,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -75024,13 +81520,13 @@ } } }, - "dependabot-alert-created": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -75095,7 +81591,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" } } } @@ -75108,7 +81604,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -75117,13 +81613,13 @@ } } }, - "dependabot-alert-dismissed": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -75188,7 +81684,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" } } } @@ -75201,7 +81697,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -75210,13 +81706,13 @@ } } }, - "dependabot-alert-fixed": { + "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -75281,7 +81777,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" } } } @@ -75294,7 +81790,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -75303,13 +81799,13 @@ } } }, - "dependabot-alert-reintroduced": { + "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-cloud@latest//rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -75374,7 +81870,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" } } } @@ -75387,7 +81883,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -75396,13 +81892,13 @@ } } }, - "dependabot-alert-reopened": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -75467,7 +81963,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-commit-comment-created" } } } @@ -75480,7 +81976,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "commit_comment", "supported-webhook-types": [ "repository", "organization", @@ -75489,13 +81985,12 @@ } } }, - "deploy-key-created": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -75560,7 +82055,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-create" } } } @@ -75573,7 +82068,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "create", "supported-webhook-types": [ "repository", "organization", @@ -75582,13 +82077,13 @@ } } }, - "deploy-key-deleted": { + "custom-property-created": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A new custom property was created.", + "operationId": "custom-property/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -75653,7 +82148,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-custom-property-created" } } } @@ -75666,22 +82161,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "deployment-created": { + "custom-property-deleted": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was deleted.", + "operationId": "custom-property/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -75746,7 +82241,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-custom-property-deleted" } } } @@ -75759,113 +82254,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "custom_property", "supported-webhook-types": [ - "repository", + "business", "organization", "app" ] } } }, - "deployment-protection-rule-requested": { - "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" - }, - "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-deployment-protection-rule-requested" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "deployment_protection_rule", - "supported-webhook-types": [ - "app" - ] - } - } - }, - "deployment-review-approved": { + "custom-property-updated": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was updated.", + "operationId": "custom-property/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { @@ -75930,7 +82334,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-custom-property-updated" } } } @@ -75943,20 +82347,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "custom_property", "supported-webhook-types": [ + "business", + "organization", "app" ] } } }, - "deployment-review-rejected": { + "custom-property-values-updated": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "The custom property values of a repository were updated.", + "operationId": "custom-property-values/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { @@ -76021,7 +82427,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" } } } @@ -76034,20 +82440,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "custom-property-values", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-requested": { + "delete": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -76112,7 +82519,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-delete" } } } @@ -76125,20 +82532,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "delete", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -76203,7 +82612,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -76216,7 +82625,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -76225,13 +82634,13 @@ } } }, - "discussion-answered": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -76296,7 +82705,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -76309,7 +82718,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -76318,13 +82727,13 @@ } } }, - "discussion-category-changed": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -76389,7 +82798,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -76402,7 +82811,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -76411,13 +82820,13 @@ } } }, - "discussion-closed": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -76439,7 +82848,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -76482,7 +82891,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -76495,7 +82904,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -76504,13 +82913,13 @@ } } }, - "discussion-comment-created": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -76575,7 +82984,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -76588,7 +82997,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -76597,13 +83006,13 @@ } } }, - "discussion-comment-deleted": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -76668,7 +83077,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -76681,7 +83090,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -76690,13 +83099,13 @@ } } }, - "discussion-comment-edited": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -76761,7 +83170,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -76774,7 +83183,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -76783,13 +83192,13 @@ } } }, - "discussion-created": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -76854,7 +83263,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -76867,7 +83276,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -76876,13 +83285,13 @@ } } }, - "discussion-deleted": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -76947,7 +83356,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -76960,7 +83369,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -76969,13 +83378,13 @@ } } }, - "discussion-edited": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -77040,7 +83449,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -77053,7 +83462,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -77062,13 +83471,13 @@ } } }, - "discussion-labeled": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -77133,7 +83542,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -77146,22 +83555,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-locked": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -77226,7 +83633,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -77239,22 +83646,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-pinned": { + "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -77319,7 +83724,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -77332,22 +83737,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-reopened": { + "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -77369,7 +83772,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -77412,7 +83815,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -77425,7 +83828,98 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#deployment_status" + }, + "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-deployment-status-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_status", "supported-webhook-types": [ "repository", "organization", @@ -77434,11 +83928,11 @@ } } }, - "discussion-transferred": { + "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -77505,7 +83999,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -77527,11 +84021,11 @@ } } }, - "discussion-unanswered": { + "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -77598,7 +84092,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -77620,11 +84114,11 @@ } } }, - "discussion-unlabeled": { + "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, @@ -77648,7 +84142,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -77691,7 +84185,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-discussion-closed" } } } @@ -77713,13 +84207,13 @@ } } }, - "discussion-unlocked": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -77784,7 +84278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-discussion-comment-created" } } } @@ -77797,7 +84291,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -77806,13 +84300,13 @@ } } }, - "discussion-unpinned": { + "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -77877,7 +84371,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" } } } @@ -77890,7 +84384,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -77899,12 +84393,13 @@ } } }, - "fork": { + "discussion-comment-edited": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" 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.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -77969,7 +84464,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" } } } @@ -77982,9 +84477,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "discussion_comment", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -77992,13 +84486,13 @@ } } }, - "github-app-authorization-revoked": { + "discussion-created": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78063,7 +84557,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -78076,19 +84570,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github_app_authorization", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "gollum": { + "discussion-deleted": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78153,7 +84650,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -78166,7 +84663,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -78175,13 +84672,13 @@ } } }, - "installation-created": { + "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78246,7 +84743,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -78259,20 +84756,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-deleted": { + "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78337,7 +84836,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -78350,20 +84849,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-new-permissions-accepted": { + "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78428,7 +84929,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -78441,20 +84942,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-added": { + "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78519,7 +85022,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -78532,20 +85035,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-removed": { + "discussion-reopened": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78567,7 +85072,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -78610,7 +85115,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -78623,20 +85128,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-suspend": { + "discussion-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78701,7 +85208,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -78714,20 +85221,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-target-renamed": { + "discussion-unanswered": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78792,7 +85301,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -78805,20 +85314,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-unsuspend": { + "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78883,7 +85394,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -78896,20 +85407,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "issue-comment-created": { + "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -78974,7 +85487,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -78987,7 +85500,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -78996,13 +85509,13 @@ } } }, - "issue-comment-deleted": { + "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-cloud@latest//discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -79067,7 +85580,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -79080,7 +85593,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -79089,13 +85602,12 @@ } } }, - "issue-comment-edited": { + "fork": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest//get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest//rest/repos/forks)\" 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.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -79160,7 +85672,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -79173,8 +85685,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "fork", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -79182,13 +85695,13 @@ } } }, - "issues-assigned": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -79253,7 +85766,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -79266,22 +85779,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "github_app_authorization", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-closed": { + "gollum": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-cloud@latest//communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -79346,7 +85856,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -79359,7 +85869,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "gollum", "supported-webhook-types": [ "repository", "organization", @@ -79368,13 +85878,13 @@ } } }, - "issues-deleted": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -79439,7 +85949,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -79452,22 +85962,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-demilestoned": { + "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -79532,7 +86040,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -79545,22 +86053,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-edited": { + "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -79625,7 +86131,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -79638,22 +86144,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-labeled": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -79718,7 +86222,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -79731,22 +86235,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation_repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-locked": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -79811,7 +86313,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -79824,22 +86326,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation_repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-milestoned": { + "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -79904,7 +86404,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -79917,22 +86417,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-opened": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -79997,7 +86495,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -80010,22 +86508,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation_target", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-pinned": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest//rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -80090,7 +86586,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -80103,7 +86599,98 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "issue-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" + }, + "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-issue-comment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -80112,13 +86699,13 @@ } } }, - "issues-reopened": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -80183,7 +86770,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -80196,7 +86783,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -80205,13 +86792,13 @@ } } }, - "issues-transferred": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-cloud@latest//rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -80276,7 +86863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -80289,7 +86876,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -80298,11 +86885,11 @@ } } }, - "issues-unassigned": { + "issues-assigned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -80369,7 +86956,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -80391,11 +86978,11 @@ } } }, - "issues-unlabeled": { + "issues-closed": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -80462,7 +87049,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -80484,11 +87071,11 @@ } } }, - "issues-unlocked": { + "issues-deleted": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -80555,7 +87142,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -80577,11 +87164,11 @@ } } }, - "issues-unpinned": { + "issues-demilestoned": { "post": { "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, @@ -80648,7 +87235,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -80670,13 +87257,13 @@ } } }, - "label-created": { + "issues-edited": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -80741,7 +87328,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -80754,7 +87341,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -80763,13 +87350,13 @@ } } }, - "label-deleted": { + "issues-labeled": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -80834,7 +87421,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -80847,7 +87434,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -80856,13 +87443,13 @@ } } }, - "label-edited": { + "issues-locked": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -80927,7 +87514,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -80940,7 +87527,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -80949,13 +87536,13 @@ } } }, - "marketplace-purchase-cancelled": { + "issues-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/cancelled", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81020,7 +87607,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -81033,20 +87620,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-changed": { + "issues-opened": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/changed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81111,7 +87700,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -81124,20 +87713,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change": { + "issues-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", - "operationId": "marketplace-purchase/pending-change", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81202,7 +87793,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -81215,20 +87806,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-pending-change-cancelled": { + "issues-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", - "operationId": "marketplace-purchase/pending-change-cancelled", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81293,7 +87886,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -81306,20 +87899,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "marketplace-purchase-purchased": { + "issues-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", - "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", - "operationId": "marketplace-purchase/purchased", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81384,7 +87979,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -81397,20 +87992,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "marketplace_purchase", + "subcategory": "issues", "supported-webhook-types": [ - "marketplace" + "repository", + "organization", + "app" ] } } }, - "member-added": { + "issues-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81475,7 +88072,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -81488,9 +88085,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "issues", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -81498,13 +88094,13 @@ } } }, - "member-edited": { + "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81569,7 +88165,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -81582,9 +88178,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "issues", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -81592,13 +88187,13 @@ } } }, - "member-removed": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81663,7 +88258,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -81676,9 +88271,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "issues", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -81686,13 +88280,13 @@ } } }, - "membership-added": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest//rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -81757,7 +88351,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -81770,22 +88364,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "membership-removed": { + "label-created": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -81850,7 +88444,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -81863,25 +88457,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "label", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "merge-group-checks-requested": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", - "operationId": "merge-group/checks-requested", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -81946,7 +88537,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -81959,23 +88550,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "label", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "merge-group-destroyed": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", - "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", - "operationId": "merge-group/destroyed", - "tags": [ - "merge-queue" - ], + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -82040,7 +88630,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -82053,20 +88643,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "merge_group", + "subcategory": "label", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "meta-deleted": { + "marketplace-purchase-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -82131,7 +88723,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } @@ -82144,24 +88736,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", - "app" + "marketplace" ] } } }, - "milestone-closed": { + "marketplace-purchase-changed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -82226,7 +88814,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } @@ -82239,22 +88827,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "milestone-created": { + "marketplace-purchase-pending-change": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -82319,7 +88905,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } @@ -82332,22 +88918,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "milestone-deleted": { + "marketplace-purchase-pending-change-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -82412,7 +88996,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } @@ -82425,22 +89009,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ - "repository", - "organization", - "app" + "marketplace" ] } } }, - "milestone-edited": { + "marketplace-purchase-purchased": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { @@ -82505,7 +89087,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } @@ -82518,8 +89100,100 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "marketplace_purchase", "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "member-added": { + "post": { + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" + }, + "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-member-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "member", + "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -82527,13 +89201,13 @@ } } }, - "milestone-opened": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -82598,7 +89272,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -82611,8 +89285,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -82620,13 +89295,13 @@ } } }, - "org-block-blocked": { + "member-removed": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -82691,7 +89366,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -82704,22 +89379,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "member", "supported-webhook-types": [ - "organization", "business", + "repository", + "organization", "app" ] } } }, - "org-block-unblocked": { + "membership-added": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -82784,7 +89460,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -82797,7 +89473,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "membership", "supported-webhook-types": [ "organization", "business", @@ -82806,13 +89482,13 @@ } } }, - "organization-deleted": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest//rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -82877,7 +89553,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -82890,7 +89566,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "membership", "supported-webhook-types": [ "organization", "business", @@ -82899,13 +89575,16 @@ } } }, - "organization-member-added": { + "merge-group-checks-requested": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -82970,7 +89649,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } @@ -82983,22 +89662,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "merge_group", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "organization-member-invited": { + "merge-group-destroyed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { @@ -83063,7 +89743,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } @@ -83076,22 +89756,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "merge_group", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "organization-member-removed": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -83156,7 +89834,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -83169,22 +89847,24 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "meta", "supported-webhook-types": [ - "organization", + "marketplace", "business", + "repository", + "organization", "app" ] } } }, - "organization-renamed": { + "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -83249,7 +89929,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -83262,22 +89942,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "package-published": { + "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -83342,7 +90022,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -83355,7 +90035,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -83364,13 +90044,13 @@ } } }, - "package-updated": { + "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -83435,7 +90115,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -83448,7 +90128,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -83457,12 +90137,13 @@ } } }, - "page-build": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -83527,7 +90208,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -83540,7 +90221,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -83549,13 +90230,13 @@ } } }, - "personal-access-token-request-approved": { + "milestone-opened": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -83567,9 +90248,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -83577,31 +90258,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -83620,7 +90301,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -83633,20 +90314,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "personal-access-token-request-cancelled": { + "org-block-blocked": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -83658,9 +90341,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -83668,31 +90351,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -83711,7 +90394,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-org-block-blocked" } } } @@ -83724,20 +90407,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "org_block", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "personal-access-token-request-created": { + "org-block-unblocked": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest//communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -83749,9 +90434,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -83759,31 +90444,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -83802,7 +90487,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -83815,20 +90500,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "org_block", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "personal-access-token-request-denied": { + "organization-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -83840,9 +90527,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -83850,31 +90537,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", + "example": "issues", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Id", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": 12312312, + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": 123123, + "example": "repository", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Delivery", "in": "header", - "example": "integration", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -83893,7 +90580,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -83906,19 +90593,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "organization", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "ping": { + "organization-member-added": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -83983,22 +90673,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -84010,26 +90685,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", - "app", "business", - "marketplace" + "app" ] } } }, - "project-card-converted": { + "organization-member-invited": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -84094,7 +90766,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -84107,22 +90779,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "project-card-created": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a project (classic).", - "operationId": "project-card/created", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -84187,7 +90859,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -84200,22 +90872,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "project-card-deleted": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was deleted.", - "operationId": "project-card/deleted", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-cloud@latest//organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest//rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -84280,7 +90952,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -84293,22 +90965,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "project-card-edited": { + "package-published": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a project (classic) was edited.", - "operationId": "project-card/edited", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -84373,7 +91045,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -84386,7 +91058,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -84395,13 +91067,13 @@ } } }, - "project-card-moved": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -84466,7 +91138,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-package-updated" } } } @@ -84479,7 +91151,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -84488,13 +91160,12 @@ } } }, - "project-closed": { + "page-build": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-cloud@latest//pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-cloud@latest//rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -84559,7 +91230,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -84572,7 +91243,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "page_build", "supported-webhook-types": [ "repository", "organization", @@ -84581,13 +91252,13 @@ } } }, - "project-column-created": { + "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a project (classic).", - "operationId": "project-column/created", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -84599,9 +91270,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -84609,31 +91280,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -84652,7 +91323,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -84665,22 +91336,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "project-column-deleted": { + "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a project (classic).", - "operationId": "project-column/deleted", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -84692,9 +91361,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -84702,31 +91371,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -84745,7 +91414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -84758,22 +91427,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "project-column-edited": { + "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a project (classic) was changed.", - "operationId": "project-column/edited", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -84785,9 +91452,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -84795,7 +91462,15 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, "schema": { "type": "string" } @@ -84811,7 +91486,58 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "repository", + "example": "integration", + "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-personal-access-token-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "personal_access_token_request", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "personal-access-token-request-denied": { + "post": { + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest//authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#personal_access_token_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" } @@ -84824,6 +91550,38 @@ "type": "string" } }, + { + "name": "X-Github-Event", + "in": "header", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "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": "integration", + "schema": { + "type": "string" + } + }, { "name": "X-Hub-Signature-256", "in": "header", @@ -84838,7 +91596,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -84851,22 +91609,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "project-column-moved": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a project (classic).", - "operationId": "project-column/moved", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -84931,7 +91686,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } } } } @@ -84943,23 +91713,26 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "project-created": { + "project-card-converted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -85024,7 +91797,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -85037,7 +91810,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -85046,13 +91819,13 @@ } } }, - "project-deleted": { + "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was deleted.", - "operationId": "project/deleted", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -85117,7 +91890,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-card-created" } } } @@ -85130,7 +91903,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -85139,13 +91912,13 @@ } } }, - "project-edited": { + "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a project (classic) was changed.", - "operationId": "project/edited", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -85210,7 +91983,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -85223,7 +91996,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -85232,13 +92005,13 @@ } } }, - "project-reopened": { + "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/reopened", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -85303,7 +92076,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -85316,7 +92089,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -85325,105 +92098,13 @@ } } }, - "projects-v2-closed": { - "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was closed.", - "operationId": "projects-v2/closed", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" - }, - "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": "project-v2", - "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-projects-v2-project-closed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "webhooks", - "subcategory": "projects_v2", - "supported-webhook-types": [ - "organization" - ] - } - } - }, - "projects-v2-created": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was created.", - "operationId": "projects-v2/created", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -85445,7 +92126,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -85488,7 +92169,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -85500,22 +92181,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project_card", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-deleted": { + "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was deleted.", - "operationId": "projects-v2/deleted", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -85537,7 +92219,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -85580,7 +92262,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -85592,22 +92274,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-edited": { + "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The title, description, or README of a project in the organization was changed.", - "operationId": "projects-v2/edited", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -85629,7 +92312,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -85672,7 +92355,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -85684,22 +92367,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-archived": { + "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -85721,7 +92405,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -85764,7 +92448,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -85776,22 +92460,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-converted": { + "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -85813,7 +92498,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -85856,7 +92541,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -85868,22 +92553,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-created": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -85905,7 +92591,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -85948,7 +92634,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -85960,22 +92646,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-deleted": { + "project-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was created.", + "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -85997,7 +92684,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -86040,7 +92727,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -86052,22 +92739,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-edited": { + "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -86089,7 +92777,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -86132,7 +92820,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -86144,22 +92832,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-reordered": { + "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -86181,7 +92870,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -86224,7 +92913,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -86236,22 +92925,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-restored": { + "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-cloud@latest//issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest//rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -86273,7 +92963,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -86316,7 +93006,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -86328,20 +93018,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-reopened": { + "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was reopened.", - "operationId": "projects-v2/reopened", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, @@ -86408,7 +93099,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -86429,12 +93120,13 @@ } } }, - "public": { + "projects-v2-created": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -86456,7 +93148,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -86499,7 +93191,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -86511,23 +93203,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "public", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-assigned": { + "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -86549,7 +93240,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -86592,7 +93283,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -86604,23 +93295,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-disabled": { + "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -86642,7 +93332,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -86685,7 +93375,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -86697,23 +93387,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-enabled": { + "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -86735,7 +93424,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -86778,7 +93467,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -86790,23 +93479,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-closed": { + "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -86828,7 +93516,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -86871,7 +93559,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -86883,23 +93571,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-converted-to-draft": { + "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -86921,7 +93608,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -86964,7 +93651,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -86976,23 +93663,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-demilestoned": { + "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -87014,7 +93700,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -87057,7 +93743,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -87069,23 +93755,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-dequeued": { + "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from the merge queue.", - "operationId": "pull-request/dequeued", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -87107,7 +93792,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -87150,7 +93835,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -87162,23 +93847,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-edited": { + "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -87200,7 +93884,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -87243,7 +93927,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -87255,23 +93939,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-enqueued": { + "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to the merge queue.", - "operationId": "pull-request/enqueued", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -87293,7 +93976,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -87336,7 +94019,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -87348,23 +94031,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-labeled": { + "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -87386,7 +94068,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -87429,7 +94111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -87441,23 +94123,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-locked": { + "projects-v2-status-update-created": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was added to a project in the organization.", + "operationId": "projects-v2-status-update/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -87479,7 +94160,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -87522,7 +94203,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -87534,23 +94215,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-milestoned": { + "projects-v2-status-update-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was removed from a project in the organization.", + "operationId": "projects-v2-status-update/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -87572,7 +94252,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -87615,7 +94295,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -87627,23 +94307,113 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-opened": { + "projects-v2-status-update-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#projects_v2_status_update" + }, + "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": "project-v2-status-update", + "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-projects-v2-status-update-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_status_update", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "public": { + "post": { + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -87708,7 +94478,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-public" } } } @@ -87721,7 +94491,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "public", "supported-webhook-types": [ "repository", "organization", @@ -87730,11 +94500,11 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-assigned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -87801,7 +94571,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -87823,11 +94593,11 @@ } } }, - "pull-request-reopened": { + "pull-request-auto-merge-disabled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -87894,7 +94664,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -87916,13 +94686,13 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-auto-merge-enabled": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -87987,7 +94757,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -88000,7 +94770,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -88009,13 +94779,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-closed": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -88080,7 +94850,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -88093,7 +94863,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -88102,13 +94872,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-converted-to-draft": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -88173,7 +94943,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -88186,7 +94956,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -88195,13 +94965,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -88266,100 +95036,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request_review", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-edited": { - "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" - }, - "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-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -88372,7 +95049,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -88381,11 +95058,11 @@ } } }, - "pull-request-review-request-removed": { + "pull-request-dequeued": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", + "description": "A pull request was removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -88452,7 +95129,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -88474,11 +95151,11 @@ } } }, - "pull-request-review-requested": { + "pull-request-edited": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -88545,7 +95222,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -88567,106 +95244,13 @@ } } }, - "pull-request-review-submitted": { - "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review" - }, - "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-pull-request-review-submitted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request_review", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-thread-resolved": { + "pull-request-enqueued": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -88731,7 +95315,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -88744,7 +95328,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -88753,13 +95337,13 @@ } } }, - "pull-request-review-thread-unresolved": { + "pull-request-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -88824,7 +95408,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -88837,7 +95421,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -88846,11 +95430,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-locked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -88917,7 +95501,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -88939,11 +95523,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-milestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -89010,7 +95594,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -89032,11 +95616,11 @@ } } }, - "pull-request-unlabeled": { + "pull-request-opened": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -89103,7 +95687,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -89125,11 +95709,11 @@ } } }, - "pull-request-unlocked": { + "pull-request-ready-for-review": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, @@ -89196,7 +95780,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -89218,12 +95802,13 @@ } } }, - "push": { + "pull-request-reopened": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -89288,7 +95873,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -89301,7 +95886,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -89310,13 +95895,13 @@ } } }, - "registry-package-published": { + "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -89381,7 +95966,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -89394,7 +95979,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -89403,13 +95988,13 @@ } } }, - "registry-package-updated": { + "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -89474,7 +96059,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -89487,7 +96072,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -89496,13 +96081,13 @@ } } }, - "release-created": { + "pull-request-review-comment-edited": { "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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "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#pull_request_review_comment" }, "parameters": [ { @@ -89567,7 +96152,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -89580,7 +96165,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -89589,13 +96174,13 @@ } } }, - "release-deleted": { + "pull-request-review-dismissed": { "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 release was deleted.", - "operationId": "release/deleted", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "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#pull_request_review" }, "parameters": [ { @@ -89660,7 +96245,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -89673,7 +96258,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -89682,13 +96267,13 @@ } } }, - "release-edited": { + "pull-request-review-edited": { "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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "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#pull_request_review" }, "parameters": [ { @@ -89753,7 +96338,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -89766,7 +96351,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -89775,13 +96360,13 @@ } } }, - "release-prereleased": { + "pull-request-review-request-removed": { "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", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "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#pull_request" }, "parameters": [ { @@ -89846,7 +96431,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -89859,7 +96444,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -89868,13 +96453,13 @@ } } }, - "release-published": { + "pull-request-review-requested": { "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", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", "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#pull_request" }, "parameters": [ { @@ -89939,7 +96524,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" } } } @@ -89952,7 +96537,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -89961,13 +96546,13 @@ } } }, - "release-released": { + "pull-request-review-submitted": { "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", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "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#pull_request_review" }, "parameters": [ { @@ -90032,7 +96617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -90045,7 +96630,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -90054,13 +96639,13 @@ } } }, - "release-unpublished": { + "pull-request-review-thread-resolved": { "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 comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", "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#pull_request_review_thread" }, "parameters": [ { @@ -90125,7 +96710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -90138,7 +96723,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -90147,13 +96732,13 @@ } } }, - "repository-advisory-published": { + "pull-request-review-thread-unresolved": { "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", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", "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#pull_request_review_thread" }, "parameters": [ { @@ -90218,7 +96803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -90231,7 +96816,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -90240,13 +96825,13 @@ } } }, - "repository-advisory-reported": { + "pull-request-synchronize": { "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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "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#pull_request" }, "parameters": [ { @@ -90311,7 +96896,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -90324,7 +96909,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -90333,13 +96918,13 @@ } } }, - "repository-archived": { + "pull-request-unassigned": { "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", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "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#pull_request" }, "parameters": [ { @@ -90404,7 +96989,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -90417,9 +97002,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "pull_request", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -90427,13 +97011,13 @@ } } }, - "repository-created": { + "pull-request-unlabeled": { "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", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "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#pull_request" }, "parameters": [ { @@ -90498,7 +97082,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -90511,9 +97095,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "pull_request", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -90521,13 +97104,13 @@ } } }, - "repository-deleted": { + "pull-request-unlocked": { "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 there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-cloud@latest//communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "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#pull_request" }, "parameters": [ { @@ -90592,7 +97175,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -90605,9 +97188,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "pull_request", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -90615,12 +97197,12 @@ } } }, - "repository-dispatch-sample.collected": { + "push": { "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). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -90685,7 +97267,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-push" } } } @@ -90698,20 +97280,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "push", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "registry-package-published": { "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", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "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#registry_package" }, "parameters": [ { @@ -90776,7 +97360,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -90789,9 +97373,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "registry_package", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -90799,12 +97382,13 @@ } } }, - "repository-import": { + "registry-package-updated": { "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 GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest//rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "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#registry_package" }, "parameters": [ { @@ -90869,7 +97453,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -90882,21 +97466,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "release-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 `private`.", - "operationId": "repository/privatized", + "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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/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#release" }, "parameters": [ { @@ -90961,7 +97546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -90974,9 +97559,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -90984,13 +97568,13 @@ } } }, - "repository-publicized": { + "release-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 visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "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 release was deleted.", + "operationId": "release/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#release" }, "parameters": [ { @@ -91055,7 +97639,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -91068,9 +97652,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -91078,13 +97661,13 @@ } } }, - "repository-renamed": { + "release-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 name of a repository was changed.", - "operationId": "repository/renamed", + "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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "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#release" }, "parameters": [ { @@ -91149,7 +97732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -91162,9 +97745,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -91172,13 +97754,13 @@ } } }, - "repository-ruleset-created": { + "release-prereleased": { "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 or organization permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "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#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -91243,7 +97825,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -91256,7 +97838,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -91265,13 +97847,13 @@ } } }, - "repository-ruleset-deleted": { + "release-published": { "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 or organization permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "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", "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#release" }, "parameters": [ { @@ -91336,7 +97918,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -91349,7 +97931,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -91358,13 +97940,13 @@ } } }, - "repository-ruleset-edited": { + "release-released": { "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 or organization permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "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", "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#release" }, "parameters": [ { @@ -91429,7 +98011,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -91442,7 +98024,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -91451,13 +98033,13 @@ } } }, - "repository-transferred": { + "release-unpublished": { "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 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", "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#release" }, "parameters": [ { @@ -91522,7 +98104,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -91535,9 +98117,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -91545,13 +98126,13 @@ } } }, - "repository-unarchived": { + "repository-advisory-published": { "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 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#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -91616,7 +98197,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -91629,9 +98210,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_advisory", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -91639,13 +98219,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-advisory-reported": { "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", + "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", "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#repository_advisory" }, "parameters": [ { @@ -91710,7 +98290,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -91723,21 +98303,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-archived": { "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", + "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_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -91802,7 +98383,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -91815,21 +98396,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-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 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", "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#repository" }, "parameters": [ { @@ -91894,7 +98477,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -91907,21 +98490,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "repository-deleted": { "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 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", "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#repository" }, "parameters": [ { @@ -91986,7 +98571,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -91999,21 +98584,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "repository-dispatch-sample.collected": { "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", + "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). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "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#repository_dispatch" }, "parameters": [ { @@ -92078,7 +98664,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -92091,22 +98677,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "secret-scanning-alert-location-created": { + "repository-edited": { "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 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#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -92171,22 +98755,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-repository-edited" } } } @@ -92198,10 +98767,10 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -92209,13 +98778,12 @@ } } }, - "secret-scanning-alert-reopened": { + "repository-import": { "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", + "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#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -92280,7 +98848,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -92293,22 +98861,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository_import", "supported-webhook-types": [ "repository", - "organization", - "app" + "organization" ] } } }, - "secret-scanning-alert-resolved": { + "repository-privatized": { "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 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", "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#repository" }, "parameters": [ { @@ -92373,7 +98940,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -92386,8 +98953,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -92395,13 +98963,13 @@ } } }, - "secret-scanning-alert-revoked": { + "repository-publicized": { "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 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#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -92466,7 +99034,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -92479,8 +99047,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -92488,13 +99057,13 @@ } } }, - "secret-scanning-alert-validated": { + "repository-renamed": { "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 validated.", - "operationId": "secret-scanning-alert/validated", + "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", "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#repository" }, "parameters": [ { @@ -92559,7 +99128,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -92572,8 +99141,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -92581,13 +99151,13 @@ } } }, - "security-advisory-published": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [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", + "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#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -92652,7 +99222,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -92665,20 +99235,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "repository_ruleset", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [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.", - "operationId": "security-advisory/updated", + "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#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -92743,7 +99315,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -92756,20 +99328,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "repository_ruleset", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [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 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#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -92834,7 +99408,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -92847,19 +99421,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "repository_ruleset", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-and-analysis": { + "repository-transferred": { "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 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#security_and_analysis" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -92924,7 +99501,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -92937,8 +99514,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -92946,13 +99524,13 @@ } } }, - "sponsorship-cancelled": { + "repository-unarchived": { "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", + "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#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -93017,7 +99595,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -93030,20 +99608,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository", "supported-webhook-types": [ - "sponsors_listing" + "business", + "repository", + "organization", + "app" ] } } }, - "sponsorship-created": { + "repository-vulnerability-alert-create": { "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", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -93108,7 +99689,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -93121,20 +99702,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "sponsorship-edited": { + "repository-vulnerability-alert-dismiss": { "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", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -93199,7 +99781,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -93212,20 +99794,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "sponsorship-pending-cancellation": { + "repository-vulnerability-alert-reopen": { "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", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "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#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -93290,7 +99873,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -93303,20 +99886,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "sponsorship-pending-tier-change": { + "repository-vulnerability-alert-resolve": { "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 a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "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#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -93381,7 +99965,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -93394,20 +99978,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "sponsorship-tier-changed": { + "secret-scanning-alert-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 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 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#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -93472,7 +100057,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -93485,20 +100070,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "star-created": { + "secret-scanning-alert-location-created": { "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 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#star" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -93563,7 +100150,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$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" + } } } } @@ -93575,8 +100177,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "star", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -93585,13 +100188,13 @@ } } }, - "star-deleted": { + "secret-scanning-alert-publicly-leaked": { "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 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 detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", "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#secret_scanning_alert" }, "parameters": [ { @@ -93656,7 +100259,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } @@ -93669,7 +100272,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -93678,12 +100281,13 @@ } } }, - "status": { + "secret-scanning-alert-reopened": { "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 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", "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#secret_scanning_alert" }, "parameters": [ { @@ -93748,7 +100352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -93761,7 +100365,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -93770,12 +100374,13 @@ } } }, - "team-add": { + "secret-scanning-alert-resolved": { "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 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#team_add" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -93840,7 +100445,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -93853,7 +100458,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -93862,13 +100467,13 @@ } } }, - "team-added-to-repository": { + "secret-scanning-alert-validated": { "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", + "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 validated.", + "operationId": "secret-scanning-alert/validated", "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#secret_scanning_alert" }, "parameters": [ { @@ -93933,7 +100538,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -93946,22 +100551,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "secret-scanning-scan-completed": { "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", + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\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 scan was completed.", + "operationId": "secret-scanning-scan/completed", "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#secret_scanning_scan" }, "parameters": [ { @@ -94026,7 +100631,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } @@ -94039,22 +100644,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "secret_scanning_scan", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-deleted": { + "security-advisory-published": { "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", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [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#team" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -94119,7 +100724,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -94132,22 +100737,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "security_advisory", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "team-edited": { + "security-advisory-updated": { "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 a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [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.", + "operationId": "security-advisory/updated", "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#security_advisory" }, "parameters": [ { @@ -94212,7 +100815,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -94225,22 +100828,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "security_advisory", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "team-removed-from-repository": { + "security-advisory-withdrawn": { "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 a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories) or [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", "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#security_advisory" }, "parameters": [ { @@ -94305,7 +100906,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -94318,22 +100919,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "security_advisory", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "watch-started": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest//account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching)\" 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 started watching the repository.", - "operationId": "watch/started", + "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#watch" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -94398,7 +100996,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -94411,7 +101009,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "security_and_analysis", "supported-webhook-types": [ "repository", "organization", @@ -94420,12 +101018,13 @@ } } }, - "workflow-dispatch": { + "sponsorship-cancelled": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", + "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#workflow_dispatch" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -94490,7 +101089,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -94503,20 +101102,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_dispatch", + "subcategory": "sponsorship", "supported-webhook-types": [ - "app" + "sponsors_listing" ] } } }, - "workflow-job-completed": { + "sponsorship-created": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", + "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#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -94581,7 +101180,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -94594,23 +101193,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "sponsorship", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "workflow-job-in-progress": { + "sponsorship-edited": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "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", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -94675,7 +101271,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -94688,23 +101284,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "sponsorship", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "workflow-job-queued": { + "sponsorship-pending-cancellation": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created.", - "operationId": "workflow-job/queued", + "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", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -94769,7 +101362,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-queued" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -94782,23 +101375,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "sponsorship", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "workflow-job-waiting": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created and is waiting for approvals.", - "operationId": "workflow-job/waiting", + "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", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -94863,7 +101453,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-waiting" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -94876,23 +101466,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "sponsorship", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "workflow-run-completed": { + "sponsorship-tier-changed": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", - "operationId": "workflow-run/completed", + "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", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -94957,7 +101544,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-completed" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -94970,9 +101557,99 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "star-created": { + "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", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + }, + "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-star-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "star", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -94980,13 +101657,13 @@ } } }, - "workflow-run-in-progress": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run started processing on a runner.", - "operationId": "workflow-run/in-progress", + "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#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -95051,7 +101728,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-in-progress" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -95064,9 +101741,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "star", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -95074,13 +101750,12 @@ } } }, - "workflow-run-requested": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run was triggered.", - "operationId": "workflow-run/requested", + "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#workflow_run" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -95145,7 +101820,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-requested" + "$ref": "#/components/schemas/webhook-status" } } } @@ -95158,369 +101833,2630 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "status", "supported-webhook-types": [ - "business", "repository", "organization", "app" ] } } - } - }, - "components": { - "schemas": { - "root": { - "type": "object", - "properties": { - "current_user_url": { - "type": "string", - "format": "uri-template" - }, - "current_user_authorizations_html_url": { - "type": "string", - "format": "uri-template" - }, - "authorizations_url": { - "type": "string", - "format": "uri-template" + }, + "sub-issues-parent-issue-added": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "code_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "commit_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "emails_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "emojis_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "events_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "feeds_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-parent-issue-removed": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "followers_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "following_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "gists_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "hub_url": { - "type": "string", - "format": "uri-template", - "deprecated": true + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "issue_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "issues_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-sub-issue-added": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "keys_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "label_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "notifications_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "organization_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "organization_repositories_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "organization_teams_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-sub-issue-removed": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "public_gists_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "rate_limit_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "repository_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "repository_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "current_user_repositories_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "team-add": { + "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", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "starred_gists_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "topic_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "user_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "user_organizations_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "user_repositories_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "user_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } } - }, - "required": [ - "current_user_url", - "current_user_authorizations_html_url", - "authorizations_url", - "code_search_url", - "commit_search_url", - "emails_url", - "emojis_url", - "events_url", - "feeds_url", - "followers_url", - "following_url", - "gists_url", - "issue_search_url", - "issues_url", - "keys_url", - "label_search_url", - "notifications_url", - "organization_url", - "organization_repositories_url", - "organization_teams_url", - "public_gists_url", - "rate_limit_url", - "repository_url", - "repository_search_url", - "current_user_repositories_url", - "starred_url", - "starred_gists_url", - "user_url", - "user_organizations_url", - "user_repositories_url", - "user_search_url" - ] - }, - "security-advisory-ecosystems": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", - "composer", - "go", - "rust", - "erlang", - "actions", - "pub", - "other", - "swift" - ] - }, - "vulnerability": { - "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", - "type": "object", - "properties": { - "package": { - "description": "The name of the package affected by the vulnerability.", - "type": "object", - "nullable": true, - "properties": { - "ecosystem": { - "$ref": "#/components/schemas/security-advisory-ecosystems" - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "nullable": true + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-add" } - }, - "required": [ - "ecosystem", - "name" - ] + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team_add", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "team-added-to-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 granted access to a repository.", + "operationId": "team/added-to-repository", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "vulnerable_version_range": { - "type": "string", - "description": "The range of the package versions affected by the vulnerability.", - "nullable": true + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "first_patched_version": { - "type": "string", - "description": "The package version that resolves the vulnerability.", - "nullable": true + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "vulnerable_functions": { - "type": "array", - "description": "The functions in the package that are affected by the vulnerability.", - "nullable": true, - "readOnly": true, - "items": { + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { "type": "string" } - } - }, - "required": [ - "package", - "vulnerable_version_range", - "first_patched_version", - "vulnerable_functions" - ] - }, - "simple-user": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" }, - "email": { - "nullable": true, - "type": "string" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "login": { - "type": "string", - "example": "octocat" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "id": { - "type": "integer", - "example": 1 + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-added-to-repository" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-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": "A team was created.", + "operationId": "team/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "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 deleted.", + "operationId": "team/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "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": "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" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "type": { - "type": "string", - "example": "User" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "site_admin": { - "type": "boolean" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", + { + "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-team-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "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'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" + }, + "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-team-removed-from-repository" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "watch-started": { + "post": { + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-cloud@latest//account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching)\" 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 started watching the repository.", + "operationId": "watch/started", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#watch" + }, + "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-watch-started" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "watch", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-dispatch": { + "post": { + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_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-workflow-dispatch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-queued": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created.", + "operationId": "workflow-job/queued", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-queued" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-waiting": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created and is waiting for approvals.", + "operationId": "workflow-job/waiting", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_job" + }, + "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-workflow-job-waiting" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", + "operationId": "workflow-run/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + }, + "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-workflow-run-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run started processing on a runner.", + "operationId": "workflow-run/in-progress", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + }, + "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-workflow-run-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-cloud@latest//actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run was triggered.", + "operationId": "workflow-run/requested", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#workflow_run" + }, + "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-workflow-run-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + } + }, + "components": { + "schemas": { + "root": { + "type": "object", + "properties": { + "current_user_url": { + "type": "string", + "format": "uri-template" + }, + "current_user_authorizations_html_url": { + "type": "string", + "format": "uri-template" + }, + "authorizations_url": { + "type": "string", + "format": "uri-template" + }, + "code_search_url": { + "type": "string", + "format": "uri-template" + }, + "commit_search_url": { + "type": "string", + "format": "uri-template" + }, + "emails_url": { + "type": "string", + "format": "uri-template" + }, + "emojis_url": { + "type": "string", + "format": "uri-template" + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "feeds_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri-template" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "hub_url": { + "type": "string", + "format": "uri-template", + "deprecated": true + }, + "issue_search_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "label_search_url": { + "type": "string", + "format": "uri-template" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "organization_url": { + "type": "string", + "format": "uri-template" + }, + "organization_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "organization_teams_url": { + "type": "string", + "format": "uri-template" + }, + "public_gists_url": { + "type": "string", + "format": "uri-template" + }, + "rate_limit_url": { + "type": "string", + "format": "uri-template" + }, + "repository_url": { + "type": "string", + "format": "uri-template" + }, + "repository_search_url": { + "type": "string", + "format": "uri-template" + }, + "current_user_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "starred_gists_url": { + "type": "string", + "format": "uri-template" + }, + "topic_search_url": { + "type": "string", + "format": "uri-template" + }, + "user_url": { + "type": "string", + "format": "uri-template" + }, + "user_organizations_url": { + "type": "string", + "format": "uri-template" + }, + "user_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "user_search_url": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "current_user_url", + "current_user_authorizations_html_url", + "authorizations_url", + "code_search_url", + "commit_search_url", + "emails_url", + "emojis_url", + "events_url", + "feeds_url", + "followers_url", + "following_url", + "gists_url", + "issue_search_url", + "issues_url", + "keys_url", + "label_search_url", + "notifications_url", + "organization_url", + "organization_repositories_url", + "organization_teams_url", + "public_gists_url", + "rate_limit_url", + "repository_url", + "repository_search_url", + "current_user_repositories_url", + "starred_url", + "starred_gists_url", + "user_url", + "user_organizations_url", + "user_repositories_url", + "user_search_url" + ] + }, + "security-advisory-ecosystems": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, + "cvss-severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "simple-user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "security-advisory-credit-types": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "global-advisory": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true, + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": "string", + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": "string", + "format": "uri", + "description": "The URL of the advisory's source code.", + "nullable": true + }, + "identifiers": { + "type": "array", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": "array", + "nullable": true, + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "nvd_published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "vulnerabilities": { + "type": "array", + "description": "The products and respective version ranges affected by the advisory.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/vulnerability" + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "epss": { + "type": "object", + "nullable": true, + "properties": { + "percentage": { + "type": "number" + }, + "percentile": { + "type": "number" + } + } + }, + "credits": { + "type": "array", + "description": "The users who contributed to the advisory.", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false + }, + "basic-error": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "validation-error-simple": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "nullable-simple-user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", "received_events_url", "repos_url", "site_admin", @@ -95528,2054 +104464,4289 @@ "subscriptions_url", "type", "url" + ], + "nullable": true + }, + "integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", + "nullable": true + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "webhook-config-url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "webhook-config-content-type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "webhook-config-secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "webhook-config-insecure-ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + }, + "webhook-config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", + "type": "object", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + } + }, + "hook-delivery-item": { + "title": "Simple webhook delivery", + "description": "Delivery made by a webhook, without request and response information.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the webhook delivery.", + "type": "integer", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id" + ] + }, + "scim-error": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "validation-error": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + "hook-delivery": { + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the delivery.", + "type": "integer", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the delivery was delivered.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + }, + "url": { + "description": "The URL target of the delivery.", + "type": "string", + "example": "https://www.example.com" + }, + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": "object", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": "string", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id", + "request", + "response" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "integration-installation-request": { + "title": "Integration Installation Request", + "description": "Request to install an integration on a target", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the request installation.", + "type": "integer", + "example": 42 + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "account": { + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/enterprise" + } + ] + }, + "requester": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-07-08T16:18:44-04:00" + } + }, + "required": [ + "id", + "account", + "requester", + "created_at" + ] + }, + "app-permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The leve of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "description": "The level of permission to grant the access token to manage team discussions and related comments.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "installation": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/enterprise" + } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/app/installations/1/access_tokens" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installation/repositories" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/organizations/github/settings/installations/1" + }, + "app_id": { + "type": "integer", + "example": 1 + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "example": "Organization" + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "contact_email": { + "type": "string", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "nullable": true + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" ] }, - "security-advisory-credit-types": { - "type": "string", - "description": "The type of credit the user is receiving.", - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" + "nullable-license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, - "global-advisory": { - "description": "A GitHub Security Advisory.", + "installation-token": { + "title": "Installation Token", + "description": "Authentication token for a GitHub App installed on a user or org.", "type": "object", "properties": { - "ghsa_id": { + "token": { + "type": "string" + }, + "expires_at": { + "type": "string" + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + }, + "repository_selection": { "type": "string", - "description": "The GitHub Security Advisory ID.", - "readOnly": true + "enum": [ + "all", + "selected" + ] }, - "cve_id": { + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "single_file": { "type": "string", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "nullable": true, - "readOnly": true + "example": "README.md" + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + } + }, + "required": [ + "token", + "expires_at" + ] + }, + "nullable-scoped-installation": { + "title": "Scoped Installation", + "type": "object", + "properties": { + "permissions": { + "$ref": "#/components/schemas/app-permissions" + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "account": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "permissions", + "repository_selection", + "single_file_name", + "repositories_url", + "account" + ], + "nullable": true + }, + "authorization": { + "title": "Authorization", + "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" }, "url": { "type": "string", - "description": "The API URL for the advisory.", - "readOnly": true + "format": "uri" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string", + "nullable": true + }, + "hashed_token": { + "type": "string", + "nullable": true + }, + "app": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "client_id", + "name", + "url" + ] + }, + "note": { + "type": "string", + "nullable": true + }, + "note_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "fingerprint": { + "type": "string", + "nullable": true + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "installation": { + "$ref": "#/components/schemas/nullable-scoped-installation" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "app", + "id", + "note", + "note_url", + "scopes", + "token", + "hashed_token", + "token_last_eight", + "fingerprint", + "url", + "created_at", + "updated_at", + "expires_at" + ] + }, + "simple-classroom-repository": { + "title": "Simple Classroom Repository", + "description": "A GitHub repository view for Classroom", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique name of the repository." }, "html_url": { "type": "string", "format": "uri", - "description": "The URL for the advisory.", - "readOnly": true + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, - "repository_advisory_url": { + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "default_branch": { + "type": "string", + "example": "main", + "description": "The default branch for the repository." + } + }, + "required": [ + "id", + "full_name", + "html_url", + "node_id", + "private", + "default_branch" + ] + }, + "simple-classroom-organization": { + "title": "Organization Simple for Classroom", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "login": { + "type": "string", + "example": "github" + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "html_url": { "type": "string", "format": "uri", - "description": "The API URL for the repository advisory.", - "readOnly": true, + "example": "https://github.com/github" + }, + "name": { + "type": "string", + "example": "Github - Code thigns happen here", "nullable": true }, - "summary": { - "type": "string", - "description": "A short summary of the advisory.", - "maxLength": 1024 + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + } + }, + "required": [ + "id", + "login", + "node_id", + "html_url", + "name", + "avatar_url" + ] + }, + "classroom": { + "title": "Classroom", + "description": "A GitHub Classroom classroom", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the classroom.", + "example": 42, + "type": "integer" + }, + "name": { + "description": "The name of the classroom.", + "type": "string", + "example": "Programming Elixir" + }, + "archived": { + "description": "Whether classroom is archived.", + "type": "boolean", + "example": false + }, + "organization": { + "$ref": "#/components/schemas/simple-classroom-organization" + }, + "url": { + "description": "The URL of the classroom on GitHub Classroom.", + "type": "string", + "example": "https://classroom.github.com/classrooms/1-programming-elixir" + } + }, + "required": [ + "id", + "name", + "archived", + "organization", + "url" + ] + }, + "classroom-assignment": { + "title": "Classroom Assignment", + "description": "A GitHub Classroom assignment", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository.", + "type": "integer", + "example": 42 + }, + "public_repo": { + "description": "Whether an accepted assignment creates a public repository.", + "type": "boolean", + "example": true }, - "description": { + "title": { + "description": "Assignment title.", "type": "string", - "description": "A detailed description of what the advisory entails.", - "maxLength": 65535, - "nullable": true + "example": "Intro to Binaries" }, "type": { + "description": "Whether it's a group assignment or individual assignment.", "type": "string", - "description": "The type of advisory.", - "readOnly": true, + "example": "individual", "enum": [ - "reviewed", - "unreviewed", - "malware" + "individual", + "group" ] }, - "severity": { + "invite_link": { + "description": "The link that a student can use to accept the assignment.", "type": "string", - "description": "The severity of the advisory.", - "enum": [ - "critical", - "high", - "medium", - "low", - "unknown" - ] + "example": "https://classroom.github.com/a/Lx7jiUgx" }, - "source_code_location": { + "invitations_enabled": { + "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", + "type": "boolean", + "example": true + }, + "slug": { + "description": "Sluggified name of the assignment.", "type": "string", - "format": "uri", - "description": "The URL of the advisory's source code.", - "nullable": true + "example": "intro-to-binaries" }, - "identifiers": { - "type": "array", + "students_are_repo_admins": { + "description": "Whether students are admins on created repository when a student accepts the assignment.", + "type": "boolean", + "example": true + }, + "feedback_pull_requests_enabled": { + "description": "Whether feedback pull request will be created when a student accepts the assignment.", + "type": "boolean", + "example": true + }, + "max_teams": { + "description": "The maximum allowable teams for the assignment.", "nullable": true, - "readOnly": true, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of identifier.", - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The identifier value." - } - }, - "required": [ - "type", - "value" - ] - } + "type": "integer", + "example": 0 }, - "references": { - "type": "array", + "max_members": { + "description": "The maximum allowable members per team.", "nullable": true, - "items": { - "type": "string", - "description": "URLs with more information regarding the advisory." - } + "type": "integer", + "example": 0 }, - "published_at": { + "editor": { + "description": "The selected editor for the assignment.", "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was published, in ISO 8601 format.", - "readOnly": true + "example": "codespaces" }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", - "readOnly": true + "accepted": { + "description": "The number of students that have accepted the assignment.", + "type": "integer", + "example": 25 }, - "github_reviewed_at": { - "type": "string", - "format": "date-time", - "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", - "readOnly": true, - "nullable": true + "submitted": { + "description": "The number of students that have submitted the assignment.", + "type": "integer", + "example": 10 }, - "nvd_published_at": { + "passing": { + "description": "The number of students that have passed the assignment.", + "type": "integer", + "example": 10 + }, + "language": { + "description": "The programming language used in the assignment.", "type": "string", - "format": "date-time", - "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", - "readOnly": true, - "nullable": true + "example": "elixir" }, - "withdrawn_at": { + "deadline": { + "description": "The time at which the assignment is due.", "type": "string", "format": "date-time", - "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", - "readOnly": true, + "example": "2011-01-26T19:06:43Z", "nullable": true }, - "vulnerabilities": { - "type": "array", - "description": "The products and respective version ranges affected by the advisory.", - "nullable": true, - "items": { - "$ref": "#/components/schemas/vulnerability" - } - }, - "cvss": { - "type": "object", - "nullable": true, - "properties": { - "vector_string": { - "type": "string", - "description": "The CVSS vector.", - "nullable": true - }, - "score": { - "type": "number", - "description": "The CVSS score.", - "minimum": 0, - "maximum": 10, - "nullable": true, - "readOnly": true - } - }, - "required": [ - "vector_string", - "score" - ] - }, - "cwes": { - "type": "array", - "nullable": true, - "items": { - "type": "object", - "properties": { - "cwe_id": { - "type": "string", - "description": "The Common Weakness Enumeration (CWE) identifier." - }, - "name": { - "type": "string", - "description": "The name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ] - } + "starter_code_repository": { + "$ref": "#/components/schemas/simple-classroom-repository" }, - "credits": { - "type": "array", - "description": "The users who contributed to the advisory.", - "nullable": true, - "readOnly": true, - "items": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/simple-user" - }, - "type": { - "$ref": "#/components/schemas/security-advisory-credit-types" - } - }, - "required": [ - "user", - "type" - ] - } + "classroom": { + "$ref": "#/components/schemas/classroom" } }, "required": [ - "ghsa_id", - "cve_id", - "url", - "html_url", - "repository_advisory_url", - "summary", - "description", + "id", + "public_repo", + "title", "type", - "severity", - "source_code_location", - "identifiers", - "references", - "published_at", - "updated_at", - "github_reviewed_at", - "nvd_published_at", - "withdrawn_at", - "vulnerabilities", - "cvss", - "cwes", - "credits" - ], - "additionalProperties": false + "invite_link", + "invitations_enabled", + "slug", + "students_are_repo_admins", + "feedback_pull_requests_enabled", + "max_teams", + "max_members", + "editor", + "accepted", + "submitted", + "passing", + "language", + "deadline", + "starter_code_repository", + "classroom" + ] }, - "basic-error": { - "title": "Basic Error", - "description": "Basic Error", + "simple-classroom-user": { + "title": "Simple Classroom User", + "description": "A GitHub user simplified for Classroom.", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "example": 1 }, - "documentation_url": { - "type": "string" + "login": { + "type": "string", + "example": "octocat" }, - "url": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "status": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" } - } + }, + "required": [ + "id", + "login", + "avatar_url", + "html_url" + ] }, - "validation-error-simple": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "simple-classroom": { + "title": "Simple Classroom", + "description": "A GitHub Classroom classroom", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" + "id": { + "description": "Unique identifier of the classroom.", + "example": 42, + "type": "integer" }, - "documentation_url": { - "type": "string" + "name": { + "description": "The name of the classroom.", + "type": "string", + "example": "Programming Elixir" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "archived": { + "description": "Returns whether classroom is archived or not.", + "type": "boolean", + "example": false + }, + "url": { + "description": "The url of the classroom on GitHub Classroom.", + "type": "string", + "example": "https://classroom.github.com/classrooms/1-programming-elixir" } - } + }, + "required": [ + "id", + "name", + "archived", + "url" + ] }, - "nullable-simple-user": { - "title": "Simple User", - "description": "A GitHub user.", + "simple-classroom-assignment": { + "title": "Simple Classroom Assignment", + "description": "A GitHub Classroom assignment", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the repository.", "type": "integer", - "example": 1 + "example": 42 }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + "public_repo": { + "description": "Whether an accepted assignment creates a public repository.", + "type": "boolean", + "example": true }, - "avatar_url": { + "title": { + "description": "Assignment title.", "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "Intro to Binaries" }, - "gravatar_id": { + "type": { + "description": "Whether it's a Group Assignment or Individual Assignment.", "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "individual", + "enum": [ + "individual", + "group" + ] }, - "url": { + "invite_link": { + "description": "The link that a student can use to accept the assignment.", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://classroom.github.com/a/Lx7jiUgx" }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "invitations_enabled": { + "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", + "type": "boolean", + "example": true }, - "followers_url": { + "slug": { + "description": "Sluggified name of the assignment.", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "intro-to-binaries" }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "students_are_repo_admins": { + "description": "Whether students are admins on created repository on accepted assignment.", + "type": "boolean", + "example": true }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "feedback_pull_requests_enabled": { + "description": "Whether feedback pull request will be created on assignment acceptance.", + "type": "boolean", + "example": true }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "max_teams": { + "description": "The maximum allowable teams for the assignment.", + "nullable": true, + "type": "integer", + "example": 0 }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "max_members": { + "description": "The maximum allowable members per team.", + "nullable": true, + "type": "integer", + "example": 0 }, - "organizations_url": { + "editor": { + "description": "The selected editor for the assignment.", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "codespaces" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "accepted": { + "description": "The number of students that have accepted the assignment.", + "type": "integer", + "example": 25 }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "submitted": { + "description": "The number of students that have submitted the assignment.", + "type": "integer", + "example": 10 }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "passing": { + "description": "The number of students that have passed the assignment.", + "type": "integer", + "example": 10 }, - "type": { + "language": { + "description": "The programming language used in the assignment.", "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "elixir" }, - "starred_at": { + "deadline": { + "description": "The time at which the assignment is due.", "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "classroom": { + "$ref": "#/components/schemas/simple-classroom" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", + "public_repo", + "title", "type", - "url" - ], - "nullable": true + "invite_link", + "invitations_enabled", + "slug", + "students_are_repo_admins", + "feedback_pull_requests_enabled", + "editor", + "accepted", + "submitted", + "passing", + "language", + "deadline", + "classroom" + ] }, - "integration": { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "classroom-accepted-assignment": { + "title": "Classroom Accepted Assignment", + "description": "A GitHub Classroom accepted assignment", "type": "object", - "nullable": true, "properties": { "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" + "description": "Unique identifier of the repository.", + "type": "integer", + "example": 42 }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" + "submitted": { + "description": "Whether an accepted assignment has been submitted.", + "type": "boolean", + "example": true }, - "node_id": { + "passing": { + "description": "Whether a submission passed.", + "type": "boolean", + "example": true + }, + "commit_count": { + "description": "Count of student commits.", + "type": "integer", + "example": 5 + }, + "grade": { + "description": "Most recent grade.", "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" + "example": "10/10" }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" + "students": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-classroom-user" + } }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", + "repository": { + "$ref": "#/components/schemas/simple-classroom-repository" + }, + "assignment": { + "$ref": "#/components/schemas/simple-classroom-assignment" + } + }, + "required": [ + "id", + "submitted", + "passing", + "commit_count", + "grade", + "students", + "repository", + "assignment" + ] + }, + "classroom-assignment-grade": { + "title": "Classroom Assignment Grade", + "description": "Grade for a student or groups GitHub Classroom assignment", + "type": "object", + "properties": { + "assignment_name": { + "description": "Name of the assignment", "type": "string" }, - "description": { + "assignment_url": { + "description": "URL of the assignment", + "type": "string" + }, + "starter_code_url": { + "description": "URL of the starter code for the assignment", + "type": "string" + }, + "github_username": { + "description": "GitHub username of the student", + "type": "string" + }, + "roster_identifier": { + "description": "Roster identifier of the student", + "type": "string" + }, + "student_repository_name": { + "description": "Name of the student's assignment repository", + "type": "string" + }, + "student_repository_url": { + "description": "URL of the student's assignment repository", + "type": "string" + }, + "submission_timestamp": { + "description": "Timestamp of the student's assignment submission", + "type": "string" + }, + "points_awarded": { + "description": "Number of points awarded to the student", + "type": "integer" + }, + "points_available": { + "description": "Number of points available for the assignment", + "type": "integer" + }, + "group_name": { + "description": "If a group assignment, name of the group the student is in", + "type": "string" + } + }, + "required": [ + "assignment_name", + "assignment_url", + "starter_code_url", + "github_username", + "roster_identifier", + "student_repository_name", + "student_repository_url", + "submission_timestamp", + "points_awarded", + "points_available" + ] + }, + "code-of-conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "The description of the app.", - "nullable": true + "example": "contributor_covenant" }, - "external_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://example.com" + "example": "Contributor Covenant" }, - "html_url": { + "url": { "type": "string", "format": "uri", - "example": "https://github.com/apps/super-ci" + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" }, - "created_at": { + "body": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" }, - "updated_at": { + "html_url": { "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "server-statistics-actions": { + "type": "object", + "description": "Actions metrics that are included in the Server Statistics payload/export from GHES", + "properties": { + "number_of_repos_using_actions": { + "description": "The total number of repositories in a GHES installation that have Actions enabled", + "type": "integer" }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" + "percentage_of_repos_using_actions": { + "description": "The percentage of repositories in a GHES installation that have Actions enabled", + "type": "string" + } + } + }, + "server-statistics-packages": { + "type": "object", + "description": "Packages metrics that are included in the Server Statistics payload/export from GHES", + "properties": { + "registry_enabled": { + "description": "Whether GitHub Packages is enabled globally in a GHES installation", + "type": "boolean" + }, + "registry_v2_enabled": { + "description": "Whether a beta registry is enabled in a GHES installation", + "type": "boolean" + }, + "ecosystems": { + "description": "The details of the package ecosystems that are enabled in a GHES installation", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "The name of the package ecosystem", + "type": "string", + "enum": [ + "npm", + "maven", + "docker", + "nuget", + "rubygems", + "containers" + ] + }, + "enabled": { + "description": "Shows if a package system is enabled, disabled, or read-only in a GHES installation", + "type": "string", + "enum": [ + "TRUE", + "FALSE", + "READONLY" + ] + }, + "published_packages_count": { + "description": "The total number of published packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "private_packages_count": { + "description": "The total number of private packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "public_packages_count": { + "description": "The total number of public packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "internal_packages_count": { + "description": "The total number of internal packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "user_packages_count": { + "description": "The total number of user packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "organization_packages_count": { + "description": "The total number of organization packages in a package ecosystem in a GHES installation", + "type": "integer" + }, + "daily_download_count": { + "description": "The total number of packages in an ecosystem that have been downloaded in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + }, + "daily_update_count": { + "description": "The total number of packages in an ecosystem that have been updated in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + }, + "daily_delete_count": { + "description": "The total number of packages in an ecosystem that have been deleted in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + }, + "daily_create_count": { + "description": "The total number of packages in an ecosystem that have been created in the 24 hours prior to `collection_date` for a GHES installation", + "type": "integer" + } } + } + } + } + }, + "server-statistics": { + "title": "Server Statistics Proxy Endpoint", + "description": "Response of S4 Proxy endpoint that provides GHES statistics", + "type": "array", + "items": { + "type": "object", + "properties": { + "server_id": { + "type": "string" }, - "additionalProperties": { + "collection_date": { "type": "string" }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { + "schema_version": { "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"", - "nullable": true + }, + "ghes_version": { + "type": "string" + }, + "host_name": { + "type": "string" + }, + "github_connect": { + "type": "object", + "properties": { + "features_enabled": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ghe_stats": { + "type": "object", + "properties": { + "comments": { + "type": "object", + "properties": { + "total_commit_comments": { + "type": "integer" + }, + "total_gist_comments": { + "type": "integer" + }, + "total_issue_comments": { + "type": "integer" + }, + "total_pull_request_comments": { + "type": "integer" + } + } + }, + "gists": { + "type": "object", + "properties": { + "total_gists": { + "type": "integer" + }, + "private_gists": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + } + } + }, + "hooks": { + "type": "object", + "properties": { + "total_hooks": { + "type": "integer" + }, + "active_hooks": { + "type": "integer" + }, + "inactive_hooks": { + "type": "integer" + } + } + }, + "issues": { + "type": "object", + "properties": { + "total_issues": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "closed_issues": { + "type": "integer" + } + } + }, + "milestones": { + "type": "object", + "properties": { + "total_milestones": { + "type": "integer" + }, + "open_milestones": { + "type": "integer" + }, + "closed_milestones": { + "type": "integer" + } + } + }, + "orgs": { + "type": "object", + "properties": { + "total_orgs": { + "type": "integer" + }, + "disabled_orgs": { + "type": "integer" + }, + "total_teams": { + "type": "integer" + }, + "total_team_members": { + "type": "integer" + } + } + }, + "pages": { + "type": "object", + "properties": { + "total_pages": { + "type": "integer" + } + } + }, + "pulls": { + "type": "object", + "properties": { + "total_pulls": { + "type": "integer" + }, + "merged_pulls": { + "type": "integer" + }, + "mergeable_pulls": { + "type": "integer" + }, + "unmergeable_pulls": { + "type": "integer" + } + } + }, + "repos": { + "type": "object", + "properties": { + "total_repos": { + "type": "integer" + }, + "root_repos": { + "type": "integer" + }, + "fork_repos": { + "type": "integer" + }, + "org_repos": { + "type": "integer" + }, + "total_pushes": { + "type": "integer" + }, + "total_wikis": { + "type": "integer" + } + } + }, + "users": { + "type": "object", + "properties": { + "total_users": { + "type": "integer" + }, + "admin_users": { + "type": "integer" + }, + "suspended_users": { + "type": "integer" + } + } + } + } + }, + "dormant_users": { + "type": "object", + "properties": { + "total_dormant_users": { + "type": "integer" + }, + "dormancy_threshold": { + "type": "string" + } + } + }, + "actions_stats": { + "$ref": "#/components/schemas/server-statistics-actions" + }, + "packages_stats": { + "$ref": "#/components/schemas/server-statistics-packages" + } + } + } + }, + "actions-cache-usage-org-enterprise": { + "type": "object", + "properties": { + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + "total_active_caches_size_in_bytes": { + "type": "integer", + "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." } }, "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" + "total_active_caches_count", + "total_active_caches_size_in_bytes" ] }, - "webhook-config-url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" + "actions-oidc-custom-issuer-policy-for-enterprise": { + "type": "object", + "properties": { + "include_enterprise_slug": { + "description": "Whether the enterprise customer requested a custom issuer URL.", + "type": "boolean", + "example": true + } + } }, - "webhook-config-content-type": { + "enabled-organizations": { "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", + "enum": [ + "all", + "none", + "selected" + ] }, - "webhook-config-secret": { + "allowed-actions": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "webhook-config-insecure-ssl": { - "oneOf": [ - { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - { - "type": "number" - } + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" ] }, - "webhook-config": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", + "selected-actions-url": { + "type": "string", + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." + }, + "actions-enterprise-permissions": { "type": "object", "properties": { - "url": { - "$ref": "#/components/schemas/webhook-config-url" + "enabled_organizations": { + "$ref": "#/components/schemas/enabled-organizations" }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" + "selected_organizations_url": { + "type": "string", + "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" } - } + }, + "required": [ + "enabled_organizations" + ] }, - "hook-delivery-item": { - "title": "Simple webhook delivery", - "description": "Delivery made by a webhook, without request and response information.", + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, "id": { - "description": "Unique identifier of the webhook delivery.", "type": "integer", - "example": 42 + "example": 1 }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "node_id": { "type": "string", - "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, - "delivered_at": { - "description": "Time when the webhook delivery occurred.", + "url": { "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "redelivery": { - "description": "Whether the webhook delivery is a redelivery.", - "type": "boolean", - "example": false + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "example": 0.03 + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "status": { - "description": "Describes the response returned after attempting the delivery.", + "hooks_url": { "type": "string", - "example": "failed to connect" + "example": "https://api.github.com/orgs/github/hooks" }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "example": 502 + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "event": { - "description": "The event that triggered the delivery.", + "members_url": { "type": "string", - "example": "issues" + "example": "https://api.github.com/orgs/github/members{/member}" }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", + "public_members_url": { "type": "string", - "example": "opened", - "nullable": true + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": "integer", - "example": 123, - "nullable": true + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": "integer", - "example": 123, + "description": { + "type": "string", + "example": "A great organization", "nullable": true } }, "required": [ + "login", + "url", "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id" + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] }, - "scim-error": { - "title": "Scim Error", - "description": "Scim Error", + "selected-actions": { "type": "object", "properties": { - "message": { - "type": "string", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "scimType": { - "type": "string", - "nullable": true + "verified_allowed": { + "type": "boolean", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." }, - "schemas": { + "patterns_allowed": { "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", "items": { "type": "string" } } } }, - "validation-error": { - "title": "Validation Error", - "description": "Validation Error", + "actions-default-workflow-permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "actions-can-approve-pull-request-reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + }, + "actions-get-default-workflow-permissions": { "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" + "default_workflow_permissions": { + "$ref": "#/components/schemas/actions-default-workflow-permissions" }, - "documentation_url": { - "type": "string" + "can_approve_pull_request_reviews": { + "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" + } + }, + "required": [ + "default_workflow_permissions", + "can_approve_pull_request_reviews" + ] + }, + "actions-set-default-workflow-permissions": { + "type": "object", + "properties": { + "default_workflow_permissions": { + "$ref": "#/components/schemas/actions-default-workflow-permissions" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } + "can_approve_pull_request_reviews": { + "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" } } }, - "hook-delivery": { - "title": "Webhook delivery", - "description": "Delivery made by a webhook.", + "runner-groups-enterprise": { "type": "object", "properties": { "id": { - "description": "Unique identifier of the delivery.", - "type": "integer", - "example": 42 - }, - "guid": { - "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", - "type": "string", - "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" - }, - "delivered_at": { - "description": "Time when the delivery was delivered.", - "type": "string", - "format": "date-time", - "example": "2021-05-12T20:33:44Z" - }, - "redelivery": { - "description": "Whether the delivery is a redelivery.", - "type": "boolean", - "example": false + "type": "number" }, - "duration": { - "description": "Time spent delivering.", - "type": "number", - "example": 0.03 + "name": { + "type": "string" }, - "status": { - "description": "Description of the status of the attempted delivery", - "type": "string", - "example": "failed to connect" + "visibility": { + "type": "string" }, - "status_code": { - "description": "Status code received when delivery was made.", - "type": "integer", - "example": 502 + "default": { + "type": "boolean" }, - "event": { - "description": "The event that triggered the delivery.", - "type": "string", - "example": "issues" + "selected_organizations_url": { + "type": "string" }, - "action": { - "description": "The type of activity for the event that triggered the delivery.", - "type": "string", - "example": "opened", - "nullable": true + "runners_url": { + "type": "string" }, - "installation_id": { - "description": "The id of the GitHub App installation associated with this event.", - "type": "integer", - "example": 123, - "nullable": true + "hosted_runners_url": { + "type": "string" }, - "repository_id": { - "description": "The id of the repository associated with this event.", - "type": "integer", - "example": 123, - "nullable": true + "allows_public_repositories": { + "type": "boolean" }, - "url": { - "description": "The URL target of the delivery.", - "type": "string", - "example": "https://www.example.com" + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false }, - "request": { - "type": "object", - "properties": { - "headers": { - "description": "The request headers sent with the webhook delivery.", - "type": "object", - "nullable": true, - "additionalProperties": true - }, - "payload": { - "description": "The webhook payload.", - "type": "object", - "nullable": true, - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false }, - "response": { - "type": "object", - "properties": { - "headers": { - "description": "The response headers received when the delivery was made.", - "type": "object", - "nullable": true, - "additionalProperties": true - }, - "payload": { - "description": "The response payload received.", - "type": "string", - "nullable": true, - "additionalProperties": true - } - }, - "required": [ - "headers", - "payload" - ] + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } } }, "required": [ "id", - "guid", - "delivered_at", - "redelivery", - "duration", - "status", - "status_code", - "event", - "action", - "installation_id", - "repository_id", - "request", - "response" + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" ] }, - "enterprise": { - "title": "Enterprise", - "description": "An enterprise on GitHub.", + "runner-label": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", "type": "object", "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true + "id": { + "type": "integer", + "description": "Unique identifier of the label." }, - "html_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" + "description": "Name of the label." }, - "website_url": { - "description": "The enterprise's website URL.", + "type": { "type": "string", - "nullable": true, - "format": "uri" - }, + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + }, + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" + "description": "The id of the runner.", + "type": "integer", + "example": 5 }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "example": 1 }, "name": { - "description": "The name of the enterprise.", + "description": "The name of the runner.", "type": "string", - "example": "Octo Business" + "example": "iMac" }, - "slug": { - "description": "The slug url identifier for the enterprise.", + "os": { + "description": "The Operating System of the runner.", "type": "string", - "example": "octo-business" + "example": "macos" }, - "created_at": { + "status": { + "description": "The status of the runner.", "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" + "example": "online" }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" + "busy": { + "type": "boolean" }, - "avatar_url": { - "type": "string", - "format": "uri" + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-label" + } } }, "required": [ "id", - "node_id", "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" + "os", + "status", + "busy", + "labels" ] }, - "integration-installation-request": { - "title": "Integration Installation Request", - "description": "Request to install an integration on a target", + "runner-application": { + "title": "Runner Application", + "description": "Runner Application", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the request installation.", - "type": "integer", - "example": 42 + "os": { + "type": "string" }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" + "architecture": { + "type": "string" }, - "account": { - "anyOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/enterprise" - } - ] + "download_url": { + "type": "string" }, - "requester": { - "$ref": "#/components/schemas/simple-user" + "filename": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2022-07-08T16:18:44-04:00" + "temp_download_token": { + "description": "A short lived bearer token used to download the runner, if needed.", + "type": "string" + }, + "sha256_checksum": { + "type": "string" } }, "required": [ - "id", - "account", - "requester", - "created_at" + "os", + "architecture", + "download_url", + "filename" ] }, - "app-permissions": { - "title": "App Permissions", + "authentication-token": { + "title": "Authentication Token", + "description": "Authentication Token", "type": "object", - "description": "The permissions granted to the user access token.", "properties": { - "actions": { + "token": { + "description": "The token used for authentication", "type": "string", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "enum": [ - "read", - "write" - ] + "example": "v1.1f699f1069f60xxx" }, - "administration": { + "expires_at": { + "description": "The time this token expires", "type": "string", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "enum": [ - "read", - "write" - ] + "format": "date-time", + "example": "2016-07-11T22:14:10Z" }, - "checks": { - "type": "string", - "description": "The level of permission to grant the access token for checks on code.", - "enum": [ - "read", - "write" - ] + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } }, - "codespaces": { - "type": "string", - "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", - "enum": [ - "read", - "write" - ] + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } }, - "contents": { + "single_file": { "type": "string", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "enum": [ - "read", - "write" - ] + "example": "config.yaml", + "nullable": true }, - "dependabot_secrets": { + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "description": "The leve of permission to grant the access token to manage Dependabot secrets.", "enum": [ - "read", - "write" + "all", + "selected" ] + } + }, + "required": [ + "token", + "expires_at" + ] + }, + "announcement-message": { + "type": "string", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "example": "Very **important** announcement about _something_.", + "nullable": true + }, + "announcement-expiration": { + "type": "string", + "format": "date-time", + "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", + "example": "\"2021-01-01T00:00:00.000-07:00\"", + "nullable": true + }, + "announcement-user-dismissible": { + "type": "boolean", + "description": "Whether an announcement can be dismissed by the user.", + "example": false, + "nullable": true, + "default": false + }, + "announcement-banner": { + "title": "Announcement Banner", + "description": "Announcement at either the repository, organization, or enterprise level", + "type": "object", + "properties": { + "announcement": { + "$ref": "#/components/schemas/announcement-message" }, - "deployments": { - "type": "string", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "enum": [ - "read", - "write" - ] + "expires_at": { + "$ref": "#/components/schemas/announcement-expiration" }, - "environments": { - "type": "string", - "description": "The level of permission to grant the access token for managing repository environments.", - "enum": [ - "read", - "write" - ] + "user_dismissible": { + "$ref": "#/components/schemas/announcement-user-dismissible" + } + }, + "required": [ + "announcement", + "expires_at", + "user_dismissible" + ] + }, + "announcement": { + "title": "Enterprise Announcement", + "description": "Enterprise global announcement", + "type": "object", + "properties": { + "announcement": { + "$ref": "#/components/schemas/announcement-message" }, - "issues": { - "type": "string", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "enum": [ - "read", - "write" - ] + "expires_at": { + "$ref": "#/components/schemas/announcement-expiration" + } + }, + "required": [ + "announcement" + ] + }, + "audit-log-event": { + "type": "object", + "properties": { + "@timestamp": { + "type": "integer", + "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." }, - "metadata": { + "action": { "type": "string", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "enum": [ - "read", - "write" - ] + "description": "The name of the action that was performed, for example `user.login` or `repo.create`." }, - "packages": { - "type": "string", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "active": { + "type": "boolean" }, - "pages": { - "type": "string", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "enum": [ - "read", - "write" - ] + "active_was": { + "type": "boolean" }, - "pull_requests": { + "actor": { "type": "string", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "enum": [ - "read", - "write" - ] + "description": "The actor who performed the action." }, - "repository_custom_properties": { + "actor_id": { + "type": "integer", + "description": "The id of the actor who performed the action." + }, + "actor_location": { + "type": "object", + "properties": { + "country_name": { + "type": "string" + } + } + }, + "data": { + "type": "object", + "additionalProperties": true + }, + "org_id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "business_id": { + "type": "integer" + }, + "blocked_user": { "type": "string", - "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", - "enum": [ - "read", - "write" - ] + "description": "The username of the account being blocked." }, - "repository_hooks": { + "business": { + "type": "string" + }, + "config": { + "type": "array", + "items": { + "type": "object" + } + }, + "config_was": { + "type": "array", + "items": { + "type": "object" + } + }, + "content_type": { + "type": "string" + }, + "operation_type": { + "type": "string" + }, + "created_at": { + "type": "integer", + "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." + }, + "deploy_key_fingerprint": { + "type": "string" + }, + "_document_id": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "enum": [ - "read", - "write" - ] + "description": "A unique identifier for an audit event." }, - "repository_projects": { + "emoji": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "object" + } + }, + "events_were": { + "type": "array", + "items": { + "type": "object" + } + }, + "explanation": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "hook_id": { + "type": "integer" + }, + "limited_availability": { + "type": "boolean" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "old_user": { + "type": "string" + }, + "openssh_public_key": { + "type": "string" + }, + "org": { + "type": "string" + }, + "previous_visibility": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "repo": { "type": "string", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "enum": [ - "read", - "write", - "admin" - ] + "description": "The name of the repository." }, - "secret_scanning_alerts": { + "repository": { "type": "string", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "enum": [ - "read", - "write" - ] + "description": "The name of the repository." }, - "secrets": { + "repository_public": { + "type": "boolean" + }, + "target_login": { + "type": "string" + }, + "team": { + "type": "string" + }, + "transport_protocol": { + "type": "integer", + "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." + }, + "transport_protocol_name": { "type": "string", - "description": "The level of permission to grant the access token to manage repository secrets.", - "enum": [ - "read", - "write" - ] + "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." }, - "security_events": { + "user": { "type": "string", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "enum": [ - "read", - "write" - ] + "description": "The user that was affected by the action performed (if available)." }, - "single_file": { + "visibility": { "type": "string", - "description": "The level of permission to grant the access token to manage just a single file.", - "enum": [ - "read", - "write" - ] + "description": "The repository visibility, for example `public` or `private`." + } + } + }, + "audit-log-stream-key": { + "title": "stream-key", + "description": "Audit Log Streaming Public Key", + "type": "object", + "properties": { + "key_id": { + "type": "string" }, - "statuses": { + "key": { + "type": "string" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "get-audit-log-stream-configs": { + "title": "List audit log streaming configurations", + "description": "Lists the audit log streaming configurations for an enterprise.", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "stream_type": { + "type": "string" + }, + "stream_details": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "paused_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "required": [ + "id", + "stream_type", + "stream_details", + "enabled", + "created_at", + "updated_at" + ] + }, + "azure-blob-config": { + "title": "AzureBlobConfig", + "description": "Azure Blob Config for audit log streaming configuration.", + "type": "object", + "properties": { + "key_id": { "type": "string", - "description": "The level of permission to grant the access token for commit statuses.", - "enum": [ - "read", - "write" - ] + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets." }, - "vulnerability_alerts": { + "encrypted_sas_url": { + "type": "string" + } + }, + "required": [ + "key_id", + "encrypted_sas_url" + ] + }, + "azure-hub-config": { + "title": "AzureHubConfig", + "description": "Azure Event Hubs Config for audit log streaming configuration.", + "type": "object", + "properties": { + "name": { "type": "string", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "enum": [ - "read", - "write" - ] + "description": "Instance name of Azure Event Hubs" }, - "workflows": { + "encrypted_connstring": { "type": "string", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "enum": [ - "write" - ] + "description": "Encrypted Connection String for Azure Event Hubs" }, - "members": { + "key_id": { "type": "string", - "description": "The level of permission to grant the access token for organization teams and members.", - "enum": [ - "read", - "write" - ] - }, - "organization_administration": { + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets." + } + }, + "required": [ + "name", + "encrypted_connstring", + "key_id" + ] + }, + "amazon-s3-oidc-config": { + "title": "AmazonS3OIDCConfig", + "description": "Amazon S3 OIDC Config for audit log streaming configuration.", + "type": "object", + "properties": { + "bucket": { "type": "string", - "description": "The level of permission to grant the access token to manage access to an organization.", - "enum": [ - "read", - "write" - ] + "description": "Amazon S3 Bucket Name." }, - "organization_custom_roles": { + "region": { "type": "string", - "description": "The level of permission to grant the access token for custom repository roles management.", - "enum": [ - "read", - "write" - ] + "description": "AWS S3 Bucket Region." }, - "organization_custom_org_roles": { + "key_id": { "type": "string", - "description": "The level of permission to grant the access token for custom organization roles management.", - "enum": [ - "read", - "write" - ] + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets." }, - "organization_custom_properties": { + "authentication_type": { "type": "string", - "description": "The level of permission to grant the access token for custom property management.", + "description": "Authentication Type for Amazon S3.", "enum": [ - "read", - "write", - "admin" + "oidc" ] }, - "organization_copilot_seat_management": { + "arn_role": { + "type": "string" + } + }, + "required": [ + "arn_role", + "authentication_type", + "bucket", + "key_id", + "region" + ] + }, + "amazon-s3-access-keys-config": { + "title": "AmazonS3AccessKeysConfig", + "description": "Amazon S3 Access Keys Config for audit log streaming configuration.", + "type": "object", + "properties": { + "bucket": { "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", - "enum": [ - "write" - ] + "description": "Amazon S3 Bucket Name." }, - "organization_announcement_banners": { + "region": { "type": "string", - "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", - "enum": [ - "read", - "write" - ] + "description": "Amazon S3 Bucket Name." }, - "organization_events": { + "key_id": { "type": "string", - "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", - "enum": [ - "read" - ] + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets." }, - "organization_hooks": { + "authentication_type": { "type": "string", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "description": "Authentication Type for Amazon S3.", "enum": [ - "read", - "write" + "access_keys" ] }, - "organization_personal_access_tokens": { + "encrypted_secret_key": { "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", - "enum": [ - "read", - "write" - ] + "description": "Encrypted AWS Secret Key." }, - "organization_personal_access_token_requests": { + "encrypted_access_key_id": { "type": "string", - "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", - "enum": [ - "read", - "write" - ] + "description": "Encrypted AWS Access Key ID." + } + }, + "required": [ + "authentication_type", + "bucket", + "encrypted_access_key_id", + "encrypted_secret_key", + "key_id", + "region" + ] + }, + "splunk-config": { + "title": "SplunkConfig", + "description": "Splunk Config for Audit Log Stream Configuration", + "type": "object", + "properties": { + "domain": { + "description": "Domain of Splunk instance.", + "type": "string" }, - "organization_plan": { - "type": "string", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "enum": [ - "read" - ] + "port": { + "description": "The port number for connecting to Splunk.", + "type": "integer" }, - "organization_projects": { + "key_id": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "enum": [ - "read", - "write", - "admin" - ] + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets." }, - "organization_packages": { - "type": "string", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "enum": [ - "read", - "write" - ] + "encrypted_token": { + "description": "Encrypted Token.", + "type": "string" }, - "organization_secrets": { + "ssl_verify": { + "description": "SSL verification helps ensure your events are sent to your Splunk endpoint securely.", + "type": "boolean" + } + }, + "required": [ + "domain", + "encrypted_token", + "key_id", + "port", + "ssl_verify" + ] + }, + "google-cloud-config": { + "title": "GoogleCloudConfig", + "description": "Google Cloud Config for audit log streaming configuration.", + "type": "object", + "properties": { + "bucket": { "type": "string", - "description": "The level of permission to grant the access token to manage organization secrets.", - "enum": [ - "read", - "write" - ] + "description": "Google Cloud Bucket Name" }, - "organization_self_hosted_runners": { + "key_id": { "type": "string", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "enum": [ - "read", - "write" - ] + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets." }, - "organization_user_blocking": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "enum": [ - "read", - "write" - ] + "encrypted_json_credentials": { + "type": "string" + } + }, + "required": [ + "bucket", + "key_id", + "encrypted_json_credentials" + ] + }, + "datadog-config": { + "title": "DatadogConfig", + "description": "Datadog Config for audit log streaming configuration.", + "type": "object", + "properties": { + "encrypted_token": { + "description": "Encrypted Splunk token.", + "type": "string" }, - "team_discussions": { + "site": { + "description": "Datadog Site to use.", "type": "string", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", "enum": [ - "read", - "write" + "US", + "US3", + "US5", + "EU1", + "US1-FED", + "AP1" ] }, - "email_addresses": { - "type": "string", - "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", - "enum": [ - "read", - "write" - ] + "key_id": { + "description": "Key ID obtained from the audit log stream key endpoint used to encrypt secrets.", + "type": "string" + } + }, + "required": [ + "encrypted_token", + "site", + "key_id" + ] + }, + "get-audit-log-stream-config": { + "title": "Get an audit log streaming configuration", + "description": "Get an audit log streaming configuration for an enterprise.", + "type": "object", + "properties": { + "id": { + "type": "integer" }, - "followers": { - "type": "string", - "description": "The level of permission to grant the access token to manage the followers belonging to a user.", - "enum": [ - "read", - "write" - ] + "stream_type": { + "type": "string" }, - "git_ssh_keys": { - "type": "string", - "description": "The level of permission to grant the access token to manage git SSH keys.", - "enum": [ - "read", - "write" - ] + "stream_details": { + "type": "string" }, - "gpg_keys": { - "type": "string", - "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", - "enum": [ - "read", - "write" - ] + "enabled": { + "type": "boolean" }, - "interaction_limits": { + "created_at": { "type": "string", - "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", - "enum": [ - "read", - "write" - ] + "format": "date-time" }, - "profile": { + "updated_at": { "type": "string", - "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", - "enum": [ - "write" - ] + "format": "date-time" }, - "starring": { + "paused_at": { "type": "string", - "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", - "enum": [ - "read", - "write" - ] + "nullable": true, + "format": "date-time" } }, - "example": { - "contents": "read", - "issues": "read", - "deployments": "write", - "single_file": "read" - } + "required": [ + "id", + "stream_type", + "stream_details", + "enabled", + "created_at", + "updated_at" + ] }, - "installation": { - "title": "Installation", - "description": "Installation", + "code-scanning-analysis-tool-name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "code-scanning-analysis-tool-guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + }, + "code-scanning-alert-state-query": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "alert-number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "alert-created-at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "alert-updated-at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "alert-url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "alert-html-url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "alert-instances-url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "code-scanning-alert-state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "alert-fixed-at": { + "type": "string", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "alert-dismissed-at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "code-scanning-alert-dismissed-reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + "code-scanning-alert-dismissed-comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "code-scanning-alert-rule-summary": { "type": "object", "properties": { "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 - }, - "account": { "nullable": true, - "anyOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/enterprise" - } - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", - "enum": [ - "all", - "selected" - ] + "description": "A unique identifier for the rule used to detect the alert." }, - "access_tokens_url": { + "name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/app/installations/1/access_tokens" + "description": "The name of the rule used to detect the alert." }, - "repositories_url": { + "severity": { + "nullable": true, "type": "string", - "format": "uri", - "example": "https://api.github.com/installation/repositories" + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] }, - "html_url": { + "security_severity_level": { + "nullable": true, "type": "string", - "format": "uri", - "example": "https://github.com/organizations/github/settings/installations/1" - }, - "app_id": { - "type": "integer", - "example": 1 - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical" + ] }, - "target_type": { + "description": { "type": "string", - "example": "Organization" + "description": "A short description of the rule used to detect the alert." }, - "permissions": { - "$ref": "#/components/schemas/app-permissions" + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." }, - "events": { + "tags": { + "nullable": true, "type": "array", + "description": "A set of tags applicable for the rule.", "items": { "type": "string" } }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { + "help": { + "nullable": true, "type": "string", - "format": "date-time" + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." }, - "single_file_name": { + "help_uri": { + "nullable": true, "type": "string", - "example": "config.yaml", - "nullable": true + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "code-scanning-analysis-tool-version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "code-scanning-analysis-tool": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-name" }, - "has_multiple_single_files": { - "type": "boolean", - "example": true + "version": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-version" }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] + "guid": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + } + } + }, + "code-scanning-ref": { + "type": "string", + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." + }, + "code-scanning-analysis-analysis-key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "code-scanning-alert-environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." + }, + "code-scanning-alert-location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" }, - "app_slug": { - "type": "string", - "example": "github-actions" + "start_line": { + "type": "integer" }, - "suspended_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "end_line": { + "type": "integer" }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true + "start_column": { + "type": "integer" }, - "contact_email": { - "type": "string", - "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", - "nullable": true + "end_column": { + "type": "integer" } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at", - "suspended_by", - "suspended_at" + } + }, + "code-scanning-alert-classification": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" ] }, - "nullable-license-simple": { - "title": "License Simple", - "description": "License Simple", + "code-scanning-alert-instance": { "type": "object", "properties": { - "key": { - "type": "string", - "example": "mit" + "ref": { + "$ref": "#/components/schemas/code-scanning-ref" }, - "name": { - "type": "string", - "example": "MIT License" + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "environment": { + "$ref": "#/components/schemas/code-scanning-alert-environment" }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "state": { + "$ref": "#/components/schemas/code-scanning-alert-state" + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "$ref": "#/components/schemas/code-scanning-alert-location" }, "html_url": { - "type": "string", - "format": "uri" + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "$ref": "#/components/schemas/code-scanning-alert-classification" + } } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true + } }, - "repository": { - "title": "Repository", - "description": "A repository on GitHub.", + "simple-repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World", + "description": "The name of the repository." }, "full_name": { "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." }, "owner": { "$ref": "#/components/schemas/simple-user" }, "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." }, "description": { "type": "string", "example": "This your first repo!", - "nullable": true + "nullable": true, + "description": "The repository description." }, "fork": { - "type": "boolean" + "type": "boolean", + "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." }, "archive_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." }, "assignees_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." }, "blobs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." }, "branches_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." }, "collaborators_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." }, "comments_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." }, "commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." }, "compare_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." }, "contents_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." }, "contributors_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." }, "deployments_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." }, "downloads_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." }, "events_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." }, "forks_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." }, "git_commits_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." }, "git_refs_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." }, "git_tags_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." }, "issue_comment_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." }, "issue_events_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." }, "issues_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." }, "keys_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." }, "labels_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." }, "languages_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." }, "merges_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." }, "milestones_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." }, "notifications_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." }, "pulls_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." }, - "open_issues": { - "type": "integer" + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." }, - "watchers": { - "type": "integer" + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." }, - "master_branch": { - "type": "string" + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." }, - "starred_at": { + "teams_url": { "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." } }, "required": [ @@ -97624,3033 +108795,3234 @@ "tags_url", "teams_url", "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "url" ] }, - "installation-token": { - "title": "Installation Token", - "description": "Authentication token for a GitHub App installed on a user or org.", + "code-scanning-organization-alert-items": { "type": "object", "properties": { - "token": { - "type": "string" + "number": { + "$ref": "#/components/schemas/alert-number" }, - "expires_at": { - "type": "string" + "created_at": { + "$ref": "#/components/schemas/alert-created-at" }, - "permissions": { - "$ref": "#/components/schemas/app-permissions" + "updated_at": { + "$ref": "#/components/schemas/alert-updated-at" }, - "repository_selection": { - "type": "string", - "enum": [ - "all", - "selected" - ] + "url": { + "$ref": "#/components/schemas/alert-url" }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository" - } + "html_url": { + "$ref": "#/components/schemas/alert-html-url" }, - "single_file": { - "type": "string", - "example": "README.md" + "instances_url": { + "$ref": "#/components/schemas/alert-instances-url" }, - "has_multiple_single_files": { - "type": "boolean", - "example": true + "state": { + "$ref": "#/components/schemas/code-scanning-alert-state" }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] + "fixed_at": { + "$ref": "#/components/schemas/alert-fixed-at" + }, + "dismissed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "dismissed_at": { + "$ref": "#/components/schemas/alert-dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "rule": { + "$ref": "#/components/schemas/code-scanning-alert-rule-summary" + }, + "tool": { + "$ref": "#/components/schemas/code-scanning-analysis-tool" + }, + "most_recent_instance": { + "$ref": "#/components/schemas/code-scanning-alert-instance" + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" } }, "required": [ - "token", - "expires_at" + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance", + "repository" ] }, - "nullable-scoped-installation": { - "title": "Scoped Installation", + "code-security-configuration": { "type": "object", + "description": "A code security configuration", "properties": { - "permissions": { - "$ref": "#/components/schemas/app-permissions" + "id": { + "type": "integer", + "description": "The ID of the code security configuration" }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { "type": "string", + "description": "The type of the code security configuration.", "enum": [ - "all", - "selected" + "global", + "organization", + "enterprise" ] }, - "single_file_name": { + "description": { "type": "string", - "example": "config.yaml", - "nullable": true - }, - "has_multiple_single_files": { - "type": "boolean", - "example": true + "description": "A description of the code security configuration" }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" ] }, - "repositories_url": { + "dependency_graph": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "account": { - "$ref": "#/components/schemas/simple-user" - } - }, - "required": [ - "permissions", - "repository_selection", - "single_file_name", - "repositories_url", - "account" - ], - "nullable": true - }, - "authorization": { - "title": "Authorization", - "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", - "type": "object", - "properties": { - "id": { - "type": "integer" + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "url": { + "dependency_graph_autosubmit_action": { "type": "string", - "format": "uri" + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "scopes": { - "description": "A list of scopes that this authorization is in.", - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } }, - "token": { - "type": "string" + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "token_last_eight": { + "dependabot_security_updates": { "type": "string", - "nullable": true + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "hashed_token": { + "code_scanning_default_setup": { "type": "string", - "nullable": true + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "app": { + "code_scanning_default_setup_options": { "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, "properties": { - "client_id": { - "type": "string" - }, - "name": { - "type": "string" + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "url": { + "runner_label": { + "nullable": true, "type": "string", - "format": "uri" + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." } - }, - "required": [ - "client_id", - "name", - "url" - ] + } }, - "note": { + "secret_scanning": { "type": "string", - "nullable": true + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "note_url": { + "secret_scanning_push_protection": { "type": "string", - "format": "uri", - "nullable": true + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "updated_at": { + "secret_scanning_delegated_bypass": { "type": "string", - "format": "date-time" + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "created_at": { - "type": "string", - "format": "date-time" + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } }, - "fingerprint": { + "secret_scanning_validity_checks": { "type": "string", - "nullable": true + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "installation": { - "$ref": "#/components/schemas/nullable-scoped-installation" + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] }, - "expires_at": { + "enforcement": { "type": "string", - "format": "date-time", - "nullable": true - } - }, - "required": [ - "app", - "id", - "note", - "note_url", - "scopes", - "token", - "hashed_token", - "token_last_eight", - "fingerprint", - "url", - "created_at", - "updated_at", - "expires_at" - ] - }, - "simple-classroom-repository": { - "title": "Simple Classroom Repository", - "description": "A GitHub repository view for Classroom", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1296269, - "description": "A unique identifier of the repository." + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] }, - "full_name": { + "url": { "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique name of the repository." + "format": "uri", + "description": "The URL of the configuration" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." + "description": "The URL of the configuration" }, - "node_id": { + "created_at": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." + "format": "date-time" }, - "default_branch": { + "updated_at": { "type": "string", - "example": "main", - "description": "The default branch for the repository." + "format": "date-time" } - }, - "required": [ - "id", - "full_name", - "html_url", - "node_id", - "private", - "default_branch" - ] + } }, - "simple-classroom-organization": { - "title": "Organization Simple for Classroom", - "description": "A GitHub organization.", + "code-scanning-default-setup-options": { "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "login": { - "type": "string", - "example": "github" - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/github" - }, - "name": { + "runner_type": { "type": "string", - "example": "Github - Code thigns happen here", - "nullable": true + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." }, - "avatar_url": { + "runner_label": { + "nullable": true, "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." } - }, - "required": [ - "id", - "login", - "node_id", - "html_url", - "name", - "avatar_url" - ] + } }, - "classroom": { - "title": "Classroom", - "description": "A GitHub Classroom classroom", + "code-security-default-configurations": { + "type": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + } + }, + "code-security-configuration-repositories": { "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", "properties": { - "id": { - "description": "Unique identifier of the classroom.", - "example": 42, - "type": "integer" - }, - "name": { - "description": "The name of the classroom.", + "status": { "type": "string", - "example": "Programming Elixir" - }, - "archived": { - "description": "Whether classroom is archived.", - "type": "boolean", - "example": false - }, - "organization": { - "$ref": "#/components/schemas/simple-classroom-organization" + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] }, - "url": { - "description": "The URL of the classroom on GitHub Classroom.", - "type": "string", - "example": "https://classroom.github.com/classrooms/1-programming-elixir" + "repository": { + "$ref": "#/components/schemas/simple-repository" } - }, - "required": [ - "id", - "name", - "archived", - "organization", - "url" - ] + } }, - "classroom-assignment": { - "title": "Classroom Assignment", - "description": "A GitHub Classroom assignment", + "enterprise-security-analysis-settings": { + "title": "Enterprise Security Analysis Settings", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository.", - "type": "integer", - "example": 42 - }, - "public_repo": { - "description": "Whether an accepted assignment creates a public repository.", + "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "example": true - }, - "title": { - "description": "Assignment title.", - "type": "string", - "example": "Intro to Binaries" - }, - "type": { - "description": "Whether it's a group assignment or individual assignment.", - "type": "string", - "example": "individual", - "enum": [ - "individual", - "group" - ] - }, - "invite_link": { - "description": "The link that a student can use to accept the assignment.", - "type": "string", - "example": "https://classroom.github.com/a/Lx7jiUgx" + "example": false, + "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise." }, - "invitations_enabled": { - "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", + "advanced_security_enabled_for_new_user_namespace_repositories": { "type": "boolean", - "example": true - }, - "slug": { - "description": "Sluggified name of the assignment.", - "type": "string", - "example": "intro-to-binaries" + "example": false, + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories." }, - "students_are_repo_admins": { - "description": "Whether students are admins on created repository when a student accepts the assignment.", + "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "example": true + "example": false, + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this\nenterprise." }, - "feedback_pull_requests_enabled": { - "description": "Whether feedback pull request will be created when a student accepts the assignment.", + "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "example": true - }, - "max_teams": { - "description": "The maximum allowable teams for the assignment.", - "nullable": true, - "type": "integer", - "example": 0 - }, - "max_members": { - "description": "The maximum allowable members per team.", - "nullable": true, - "type": "integer", - "example": 0 - }, - "editor": { - "description": "The selected editor for the assignment.", - "type": "string", - "example": "codespaces" - }, - "accepted": { - "description": "The number of students that have accepted the assignment.", - "type": "integer", - "example": 25 - }, - "submitted": { - "description": "The number of students that have submitted the assignment.", - "type": "integer", - "example": 10 - }, - "passing": { - "description": "The number of students that have passed the assignment.", - "type": "integer", - "example": 10 + "example": false, + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\nenterprise." }, - "language": { - "description": "The programming language used in the assignment.", - "type": "string", - "example": "elixir" + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this enterprise." }, - "deadline": { - "description": "The time at which the assignment is due.", + "secret_scanning_push_protection_custom_link": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "nullable": true, + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." }, - "starter_code_repository": { - "$ref": "#/components/schemas/simple-classroom-repository" + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise." }, - "classroom": { - "$ref": "#/components/schemas/classroom" + "secret_scanning_validity_checks_enabled": { + "type": "boolean", + "example": false, + "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise." } }, "required": [ - "id", - "public_repo", - "title", - "type", - "invite_link", - "invitations_enabled", - "slug", - "students_are_repo_admins", - "feedback_pull_requests_enabled", - "max_teams", - "max_members", - "editor", - "accepted", - "submitted", - "passing", - "language", - "deadline", - "starter_code_repository", - "classroom" + "advanced_security_enabled_for_new_repositories", + "dependabot_alerts_enabled_for_new_repositories", + "secret_scanning_enabled_for_new_repositories", + "secret_scanning_push_protection_enabled_for_new_repositories" ] }, - "simple-classroom-user": { - "title": "Simple Classroom User", - "description": "A GitHub user simplified for Classroom.", + "get-consumed-licenses": { + "title": "Enterprise Consumed Licenses", + "description": "A breakdown of the licenses consumed by an enterprise.", + "properties": { + "total_seats_consumed": { + "type": "integer" + }, + "total_seats_purchased": { + "type": "integer" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "github_com_login": { + "type": "string" + }, + "github_com_name": { + "type": "string", + "nullable": true + }, + "enterprise_server_user_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "github_com_user": { + "type": "boolean" + }, + "enterprise_server_user": { + "type": "boolean", + "nullable": true + }, + "visual_studio_subscription_user": { + "type": "boolean" + }, + "license_type": { + "type": "string" + }, + "github_com_profile": { + "type": "string", + "nullable": true + }, + "github_com_member_roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "github_com_enterprise_roles": { + "type": "array", + "description": "All enterprise roles for a user.", + "items": { + "type": "string" + } + }, + "github_com_verified_domain_emails": { + "type": "array", + "items": { + "type": "string" + } + }, + "github_com_saml_name_id": { + "type": "string", + "nullable": true + }, + "github_com_orgs_with_pending_invites": { + "type": "array", + "items": { + "type": "string" + } + }, + "github_com_two_factor_auth": { + "type": "boolean", + "nullable": true + }, + "enterprise_server_emails": { + "type": "array", + "items": { + "type": "string" + } + }, + "visual_studio_license_status": { + "type": "string", + "nullable": true + }, + "visual_studio_subscription_email": { + "type": "string", + "nullable": true + }, + "total_user_accounts": { + "type": "integer" + } + } + } + } + } + }, + "nullable-organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, "id": { "type": "integer", "example": 1 }, - "login": { + "node_id": { "type": "string", - "example": "octocat" + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, - "avatar_url": { + "url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://api.github.com/orgs/github" }, - "html_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" - } - }, - "required": [ - "id", - "login", - "avatar_url", - "html_url" - ] - }, - "simple-classroom": { - "title": "Simple Classroom", - "description": "A GitHub Classroom classroom", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the classroom.", - "example": 42, - "type": "integer" + "example": "https://api.github.com/orgs/github/repos" }, - "name": { - "description": "The name of the classroom.", + "events_url": { "type": "string", - "example": "Programming Elixir" + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "archived": { - "description": "Returns whether classroom is archived or not.", - "type": "boolean", - "example": false + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "url": { - "description": "The url of the classroom on GitHub Classroom.", + "issues_url": { "type": "string", - "example": "https://classroom.github.com/classrooms/1-programming-elixir" + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true } }, "required": [ + "login", + "url", "id", - "name", - "archived", - "url" - ] + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true }, - "simple-classroom-assignment": { - "title": "Simple Classroom Assignment", - "description": "A GitHub Classroom assignment", + "nullable-team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository.", + "description": "Unique identifier of the team", "type": "integer", - "example": 42 - }, - "public_repo": { - "description": "Whether an accepted assignment creates a public repository.", - "type": "boolean", - "example": true + "example": 1 }, - "title": { - "description": "Assignment title.", + "node_id": { "type": "string", - "example": "Intro to Binaries" + "example": "MDQ6VGVhbTE=" }, - "type": { - "description": "Whether it's a Group Assignment or Individual Assignment.", + "url": { + "description": "URL for the team", "type": "string", - "example": "individual", - "enum": [ - "individual", - "group" - ] + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" }, - "invite_link": { - "description": "The link that a student can use to accept the assignment.", + "members_url": { "type": "string", - "example": "https://classroom.github.com/a/Lx7jiUgx" - }, - "invitations_enabled": { - "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", - "type": "boolean", - "example": true + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "slug": { - "description": "Sluggified name of the assignment.", + "name": { + "description": "Name of the team", "type": "string", - "example": "intro-to-binaries" - }, - "students_are_repo_admins": { - "description": "Whether students are admins on created repository on accepted assignment.", - "type": "boolean", - "example": true - }, - "feedback_pull_requests_enabled": { - "description": "Whether feedback pull request will be created on assignment acceptance.", - "type": "boolean", - "example": true - }, - "max_teams": { - "description": "The maximum allowable teams for the assignment.", - "nullable": true, - "type": "integer", - "example": 0 + "example": "Justice League" }, - "max_members": { - "description": "The maximum allowable members per team.", + "description": { + "description": "Description of the team", + "type": "string", "nullable": true, - "type": "integer", - "example": 0 + "example": "A great team." }, - "editor": { - "description": "The selected editor for the assignment.", + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "example": "codespaces" - }, - "accepted": { - "description": "The number of students that have accepted the assignment.", - "type": "integer", - "example": 25 - }, - "submitted": { - "description": "The number of students that have submitted the assignment.", - "type": "integer", - "example": 10 - }, - "passing": { - "description": "The number of students that have passed the assignment.", - "type": "integer", - "example": 10 + "example": "admin" }, - "language": { - "description": "The programming language used in the assignment.", + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "example": "elixir" + "example": "closed" }, - "deadline": { - "description": "The time at which the assignment is due.", + "notification_setting": { + "description": "The notification setting the team has set", "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "classroom": { - "$ref": "#/components/schemas/simple-classroom" - } - }, - "required": [ - "id", - "public_repo", - "title", - "type", - "invite_link", - "invitations_enabled", - "slug", - "students_are_repo_admins", - "feedback_pull_requests_enabled", - "editor", - "accepted", - "submitted", - "passing", - "language", - "deadline", - "classroom" - ] - }, - "classroom-accepted-assignment": { - "title": "Classroom Accepted Assignment", - "description": "A GitHub Classroom accepted assignment", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository.", - "type": "integer", - "example": 42 - }, - "submitted": { - "description": "Whether an accepted assignment has been submitted.", - "type": "boolean", - "example": true - }, - "passing": { - "description": "Whether a submission passed.", - "type": "boolean", - "example": true - }, - "commit_count": { - "description": "Count of student commits.", - "type": "integer", - "example": 5 + "example": "notifications_enabled" }, - "grade": { - "description": "Most recent grade.", + "html_url": { "type": "string", - "example": "10/10" + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" }, - "students": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-classroom-user" - } + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "repository": { - "$ref": "#/components/schemas/simple-classroom-repository" + "slug": { + "type": "string", + "example": "justice-league" }, - "assignment": { - "$ref": "#/components/schemas/simple-classroom-assignment" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "required": [ "id", - "submitted", - "passing", - "commit_count", - "grade", - "students", - "repository", - "assignment" - ] + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true }, - "classroom-assignment-grade": { - "title": "Classroom Assignment Grade", - "description": "Grade for a student or groups GitHub Classroom assignment", + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "assignment_name": { - "description": "Name of the assignment", - "type": "string" + "id": { + "type": "integer" }, - "assignment_url": { - "description": "URL of the assignment", + "node_id": { "type": "string" }, - "starter_code_url": { - "description": "URL of the starter code for the assignment", + "name": { "type": "string" }, - "github_username": { - "description": "GitHub username of the student", + "slug": { "type": "string" }, - "roster_identifier": { - "description": "Roster identifier of the student", - "type": "string" + "description": { + "type": "string", + "nullable": true }, - "student_repository_name": { - "description": "Name of the student's assignment repository", + "privacy": { "type": "string" }, - "student_repository_url": { - "description": "URL of the student's assignment repository", + "notification_setting": { "type": "string" }, - "submission_timestamp": { - "description": "Timestamp of the student's assignment submission", + "permission": { "type": "string" }, - "points_awarded": { - "description": "Number of points awarded to the student", - "type": "integer" + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] }, - "points_available": { - "description": "Number of points available for the assignment", - "type": "integer" + "url": { + "type": "string", + "format": "uri" }, - "group_name": { - "description": "If a group assignment, name of the group the student is in", + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" } }, "required": [ - "assignment_name", - "assignment_url", - "starter_code_url", - "github_username", - "roster_identifier", - "student_repository_name", - "student_repository_url", - "submission_timestamp", - "points_awarded", - "points_available" + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" ] }, - "code-of-conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", "type": "object", "properties": { - "key": { - "type": "string", - "example": "contributor_covenant" + "id": { + "type": "integer", + "format": "int64" }, "name": { - "type": "string", - "example": "Contributor Covenant" + "type": "string" + }, + "slug": { + "type": "string" }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + "format": "uri" }, - "body": { + "sync_to_organizations": { "type": "string", - "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + "example": "disabled | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" }, "html_url": { "type": "string", "format": "uri", - "nullable": true + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } }, "required": [ + "id", "url", + "members_url", + "sync_to_organizations", + "name", "html_url", - "key", - "name" + "slug", + "created_at", + "updated_at" ] }, - "server-statistics-actions": { + "copilot-seat-details": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", "type": "object", - "description": "Actions metrics that are included in the Server Statistics payload/export from GHES", "properties": { - "number_of_repos_using_actions": { - "description": "The total number of repositories in a GHES installation that have Actions enabled", - "type": "integer" + "assignee": { + "$ref": "#/components/schemas/simple-user" }, - "percentage_of_repos_using_actions": { - "description": "The percentage of repositories in a GHES installation that have Actions enabled", - "type": "string" + "organization": { + "$ref": "#/components/schemas/nullable-organization-simple" + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] } - } + }, + "required": [ + "assignee", + "created_at" + ], + "additionalProperties": false }, - "server-statistics-packages": { + "copilot-ide-code-completions": { "type": "object", - "description": "Packages metrics that are included in the Server Statistics payload/export from GHES", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "additionalProperties": true, "properties": { - "registry_enabled": { - "description": "Whether GitHub Packages is enabled globally in a GHES installation", - "type": "boolean" - }, - "registry_v2_enabled": { - "description": "Whether a beta registry is enabled in a GHES installation", - "type": "boolean" + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." }, - "ecosystems": { - "description": "The details of the package ecosystems that are enabled in a GHES installation", + "languages": { "type": "array", + "description": "Code completion metrics for active languages.", "items": { "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", "properties": { "name": { - "description": "The name of the package ecosystem", "type": "string", - "enum": [ - "npm", - "maven", - "docker", - "nuget", - "rubygems", - "containers" - ] + "description": "Name of the language used for Copilot code completion suggestions." }, - "enabled": { - "description": "Shows if a package system is enabled, disabled, or read-only in a GHES installation", + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { "type": "string", - "enum": [ - "TRUE", - "FALSE", - "READONLY" - ] - }, - "published_packages_count": { - "description": "The total number of published packages in a package ecosystem in a GHES installation", - "type": "integer" - }, - "private_packages_count": { - "description": "The total number of private packages in a package ecosystem in a GHES installation", - "type": "integer" - }, - "public_packages_count": { - "description": "The total number of public packages in a package ecosystem in a GHES installation", - "type": "integer" - }, - "internal_packages_count": { - "description": "The total number of internal packages in a package ecosystem in a GHES installation", - "type": "integer" - }, - "user_packages_count": { - "description": "The total number of user packages in a package ecosystem in a GHES installation", - "type": "integer" - }, - "organization_packages_count": { - "description": "The total number of organization packages in a package ecosystem in a GHES installation", - "type": "integer" - }, - "daily_download_count": { - "description": "The total number of packages in an ecosystem that have been downloaded in the 24 hours prior to `collection_date` for a GHES installation", - "type": "integer" - }, - "daily_update_count": { - "description": "The total number of packages in an ecosystem that have been updated in the 24 hours prior to `collection_date` for a GHES installation", - "type": "integer" + "description": "Name of the given editor." }, - "daily_delete_count": { - "description": "The total number of packages in an ecosystem that have been deleted in the 24 hours prior to `collection_date` for a GHES installation", - "type": "integer" + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." }, - "daily_create_count": { - "description": "The total number of packages in an ecosystem that have been created in the 24 hours prior to `collection_date` for a GHES installation", - "type": "integer" + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } } } } } } }, - "server-statistics": { - "title": "Server Statistics Proxy Endpoint", - "description": "Response of S4 Proxy endpoint that provides GHES statistics", - "type": "array", - "items": { - "type": "object", - "properties": { - "server_id": { - "type": "string" - }, - "collection_date": { - "type": "string" - }, - "schema_version": { - "type": "string" - }, - "ghes_version": { - "type": "string" - }, - "host_name": { - "type": "string" - }, - "github_connect": { + "copilot-ide-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { "type": "object", + "description": "Copilot Chat metrics, for active editors.", "properties": { - "features_enabled": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { "type": "array", + "description": "List of model metrics for custom models and the default model.", "items": { - "type": "string" + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } } } } - }, - "ghe_stats": { + } + } + } + }, + "copilot-dotcom-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { "type": "object", "properties": { - "comments": { - "type": "object", - "properties": { - "total_commit_comments": { - "type": "integer" - }, - "total_gist_comments": { - "type": "integer" - }, - "total_issue_comments": { - "type": "integer" - }, - "total_pull_request_comments": { - "type": "integer" - } - } - }, - "gists": { - "type": "object", - "properties": { - "total_gists": { - "type": "integer" - }, - "private_gists": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - } - } - }, - "hooks": { - "type": "object", - "properties": { - "total_hooks": { - "type": "integer" - }, - "active_hooks": { - "type": "integer" - }, - "inactive_hooks": { - "type": "integer" - } - } - }, - "issues": { - "type": "object", - "properties": { - "total_issues": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "closed_issues": { - "type": "integer" - } - } - }, - "milestones": { - "type": "object", - "properties": { - "total_milestones": { - "type": "integer" - }, - "open_milestones": { - "type": "integer" - }, - "closed_milestones": { - "type": "integer" - } - } - }, - "orgs": { - "type": "object", - "properties": { - "total_orgs": { - "type": "integer" - }, - "disabled_orgs": { - "type": "integer" - }, - "total_teams": { - "type": "integer" - }, - "total_team_members": { - "type": "integer" - } - } + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." }, - "pages": { - "type": "object", - "properties": { - "total_pages": { - "type": "integer" - } - } + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." }, - "pulls": { - "type": "object", - "properties": { - "total_pulls": { - "type": "integer" - }, - "merged_pulls": { - "type": "integer" - }, - "mergeable_pulls": { - "type": "integer" - }, - "unmergeable_pulls": { - "type": "integer" - } - } + "custom_model_training_date": { + "type": "string", + "description": "The training date for the custom model (if applicable).", + "nullable": true }, - "repos": { - "type": "object", - "properties": { - "total_repos": { - "type": "integer" - }, - "root_repos": { - "type": "integer" - }, - "fork_repos": { - "type": "integer" - }, - "org_repos": { - "type": "integer" - }, - "total_pushes": { - "type": "integer" - }, - "total_wikis": { - "type": "integer" - } - } + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." }, - "users": { - "type": "object", - "properties": { - "total_users": { - "type": "integer" - }, - "admin_users": { - "type": "integer" - }, - "suspended_users": { - "type": "integer" - } - } + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." } } - }, - "dormant_users": { + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": "object", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { "type": "object", "properties": { - "total_dormant_users": { - "type": "integer" + "name": { + "type": "string", + "description": "Repository name" }, - "dormancy_threshold": { - "type": "string" + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } } } - }, - "actions_stats": { - "$ref": "#/components/schemas/server-statistics-actions" - }, - "packages_stats": { - "$ref": "#/components/schemas/server-statistics-packages" } } } }, - "actions-cache-usage-org-enterprise": { + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", "type": "object", "properties": { - "total_active_caches_count": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { "type": "integer", - "description": "The count of active caches across all repositories of an enterprise or an organization." + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." }, - "total_active_caches_size_in_bytes": { + "total_engaged_users": { "type": "integer", - "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" } }, "required": [ - "total_active_caches_count", - "total_active_caches_size_in_bytes" - ] + "date" + ], + "additionalProperties": true }, - "actions-oidc-custom-issuer-policy-for-enterprise": { + "copilot-usage-metrics": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", "type": "object", "properties": { - "include_enterprise_slug": { - "description": "Whether the enterprise customer requested a custom issuer URL.", - "type": "boolean", - "example": true + "day": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." + }, + "total_suggestions_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions shown to users." + }, + "total_acceptances_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions accepted by users." + }, + "total_lines_suggested": { + "type": "integer", + "description": "The total number of lines of code completions suggested by Copilot." + }, + "total_lines_accepted": { + "type": "integer", + "description": "The total number of lines of code completions accepted by users." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + }, + "total_chat_acceptances": { + "type": "integer", + "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + }, + "total_chat_turns": { + "type": "integer", + "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + }, + "total_active_chat_users": { + "type": "integer", + "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + }, + "breakdown": { + "type": "array", + "description": "Breakdown of Copilot code completions usage by language and editor", + "nullable": true, + "items": { + "type": "object", + "description": "Breakdown of Copilot usage by editor for this language", + "additionalProperties": true, + "properties": { + "language": { + "type": "string", + "description": "The language in which Copilot suggestions were shown to users in the specified editor." + }, + "editor": { + "type": "string", + "description": "The editor in which Copilot suggestions were shown to users for the specified language." + }, + "suggestions_count": { + "type": "integer", + "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." + }, + "acceptances_count": { + "type": "integer", + "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." + }, + "lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." + }, + "lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted by users in the editor specified during the day specified." + }, + "active_users": { + "type": "integer", + "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." + } + } + } } - } + }, + "required": [ + "day", + "breakdown" + ], + "additionalProperties": false }, - "enabled-organizations": { - "type": "string", - "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "enum": [ - "all", - "none", - "selected" - ] + "dependabot-alert-package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false }, - "allowed-actions": { - "type": "string", - "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", - "enum": [ - "all", - "local_only", - "selected" - ] + "dependabot-alert-security-vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "$ref": "#/components/schemas/dependabot-alert-package" + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": "object", + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "nullable": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false }, - "selected-actions-url": { + "dependabot-alert-security-advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": "string", + "description": "The full CVSS vector string for the advisory.", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": "string", + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false + }, + "alert-auto-dismissed-at": { "type": "string", - "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true }, - "actions-enterprise-permissions": { + "dependabot-alert-with-repository": { "type": "object", + "description": "A Dependabot alert.", "properties": { - "enabled_organizations": { - "$ref": "#/components/schemas/enabled-organizations" + "number": { + "$ref": "#/components/schemas/alert-number" }, - "selected_organizations_url": { + "state": { "type": "string", - "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." - }, - "allowed_actions": { - "$ref": "#/components/schemas/allowed-actions" + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] }, - "selected_actions_url": { - "$ref": "#/components/schemas/selected-actions-url" - } - }, - "required": [ - "enabled_organizations" - ] - }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "$ref": "#/components/schemas/dependabot-alert-package" + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": "string", + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "nullable": true, + "enum": [ + "development", + "runtime" + ] + } + } }, - "id": { - "type": "integer", - "example": 1 + "security_advisory": { + "$ref": "#/components/schemas/dependabot-alert-security-advisory" }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + "security_vulnerability": { + "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" + "$ref": "#/components/schemas/alert-url" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" + "html_url": { + "$ref": "#/components/schemas/alert-html-url" }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" + "created_at": { + "$ref": "#/components/schemas/alert-created-at" }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" + "updated_at": { + "$ref": "#/components/schemas/alert-updated-at" }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" + "dismissed_at": { + "$ref": "#/components/schemas/alert-dismissed-at" }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" + "dismissed_by": { + "$ref": "#/components/schemas/nullable-simple-user" }, - "public_members_url": { + "dismissed_reason": { "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" + "description": "The reason that the alert was dismissed.", + "nullable": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk" + ] }, - "avatar_url": { + "dismissed_comment": { "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": "An optional comment associated with the alert's dismissal.", + "nullable": true, + "maxLength": 280 }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true + "fixed_at": { + "$ref": "#/components/schemas/alert-fixed-at" + }, + "auto_dismissed_at": { + "$ref": "#/components/schemas/alert-auto-dismissed-at" + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" } }, "required": [ - "login", + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false }, - "selected-actions": { - "type": "object", + "get-license-sync-status": { + "title": "License Sync Status", + "description": "Information about the status of a license sync job for an enterprise.", "properties": { - "github_owned_allowed": { - "type": "boolean", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." - }, - "verified_allowed": { - "type": "boolean", - "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." - }, - "patterns_allowed": { + "server_instances": { "type": "array", - "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.", "items": { - "type": "string" + "type": "object", + "properties": { + "server_id": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "last_sync": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "status": { + "type": "string" + }, + "error": { + "type": "string" + } + } + } + } } } } }, - "actions-default-workflow-permissions": { - "type": "string", - "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", - "enum": [ - "read", - "write" - ] - }, - "actions-can-approve-pull-request-reviews": { - "type": "boolean", - "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." - }, - "actions-get-default-workflow-permissions": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "$ref": "#/components/schemas/actions-default-workflow-permissions" - }, - "can_approve_pull_request_reviews": { - "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" - } - }, - "required": [ - "default_workflow_permissions", - "can_approve_pull_request_reviews" - ] - }, - "actions-set-default-workflow-permissions": { - "type": "object", - "properties": { - "default_workflow_permissions": { - "$ref": "#/components/schemas/actions-default-workflow-permissions" - }, - "can_approve_pull_request_reviews": { - "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" - } - } - }, - "runner-groups-enterprise": { + "custom-property": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", "type": "object", "properties": { - "id": { - "type": "number" - }, - "name": { - "type": "string" - }, - "visibility": { - "type": "string" - }, - "default": { - "type": "boolean" + "property_name": { + "type": "string", + "description": "The name of the property" }, - "selected_organizations_url": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." }, - "runners_url": { - "type": "string" + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" }, - "allows_public_repositories": { - "type": "boolean" + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" }, - "workflow_restrictions_read_only": { - "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "required": { "type": "boolean", - "default": false + "description": "Whether the property is required." }, - "restricted_to_workflows": { - "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", - "type": "boolean", - "default": false + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" }, - "selected_workflows": { - "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { "type": "array", "items": { "type": "string", - "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", - "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" - } + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ - "id", - "name", - "visibility", - "allows_public_repositories", - "default", - "runners_url" + "property_name", + "value_type" ] }, - "runner-label": { - "title": "Self hosted runner label", - "description": "A label for a self hosted runner", + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { - "id": { - "type": "integer", - "description": "Unique identifier of the label." - }, - "name": { + "value_type": { "type": "string", - "description": "Name of the label." + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" }, - "type": { + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { "type": "string", - "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", - "enum": [ - "read-only", - "custom" - ] + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } }, "required": [ - "name" + "value_type" ] }, - "runner": { - "title": "Self hosted runners", - "description": "A self hosted runner", + "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 not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "repository-ruleset-bypass-actor": { + "title": "Repository Ruleset Bypass Actor", "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], "properties": { - "id": { - "description": "The id of the runner.", - "type": "integer", - "example": 5 - }, - "runner_group_id": { - "description": "The id of the runner group.", + "actor_id": { "type": "integer", - "example": 1 - }, - "name": { - "description": "The name of the runner.", - "type": "string", - "example": "iMac" + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, - "os": { - "description": "The Operating System of the runner.", + "actor_type": { "type": "string", - "example": "macos" + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" }, - "status": { - "description": "The status of the runner.", + "bypass_mode": { "type": "string", - "example": "online" - }, - "busy": { - "type": "boolean" - }, - "labels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/runner-label" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + }, + "enterprise-ruleset-conditions-organization-name-target": { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } } } }, "required": [ - "id", - "name", - "os", - "status", - "busy", - "labels" + "organization_name" ] }, - "runner-application": { - "title": "Runner Application", - "description": "Runner Application", + "repository-ruleset-conditions-repository-name-target": { + "title": "Repository ruleset conditions for repository names", "type": "object", + "description": "Parameters for a repository name condition", "properties": { - "os": { - "type": "string" - }, - "architecture": { - "type": "string" - }, - "download_url": { - "type": "string" - }, - "filename": { - "type": "string" - }, - "temp_download_token": { - "description": "A short lived bearer token used to download the runner, if needed.", - "type": "string" - }, - "sha256_checksum": { - "type": "string" + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } } }, "required": [ - "os", - "architecture", - "download_url", - "filename" + "repository_name" ] }, - "authentication-token": { - "title": "Authentication Token", - "description": "Authentication Token", + "repository-ruleset-conditions": { + "title": "Repository ruleset conditions for ref names", "type": "object", + "description": "Parameters for a repository ruleset ref name condition", "properties": { - "token": { - "description": "The token used for authentication", - "type": "string", - "example": "v1.1f699f1069f60xxx" - }, - "expires_at": { - "description": "The time this token expires", - "type": "string", - "format": "date-time", - "example": "2016-07-11T22:14:10Z" - }, - "permissions": { + "ref_name": { "type": "object", - "example": { - "issues": "read", - "deployments": "write" + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } } + } + } + }, + "repository-ruleset-conditions-repository-property-spec": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" }, - "repositories": { - "description": "The repositories this token has access to", + "property_values": { "type": "array", + "description": "The values to match for the repository property", "items": { - "$ref": "#/components/schemas/repository" + "type": "string" } }, - "single_file": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "source": { "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", "enum": [ - "all", - "selected" + "custom", + "system" ] } }, "required": [ - "token", - "expires_at" + "name", + "property_values" ] }, - "announcement-message": { - "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "example": "Very **important** announcement about _something_.", - "nullable": true - }, - "announcement-expiration": { - "type": "string", - "format": "date-time", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "example": "\"2021-01-01T00:00:00.000-07:00\"", - "nullable": true - }, - "announcement-user-dismissible": { - "type": "boolean", - "description": "Whether an announcement can be dismissed by the user.", - "example": false, - "nullable": true, - "default": false - }, - "announcement-banner": { - "title": "Announcement Banner", - "description": "Announcement at either the repository, organization, or enterprise level", + "repository-ruleset-conditions-repository-property-target": { + "title": "Repository ruleset conditions for repository properties", "type": "object", + "description": "Parameters for a repository property condition", "properties": { - "announcement": { - "$ref": "#/components/schemas/announcement-message" - }, - "expires_at": { - "$ref": "#/components/schemas/announcement-expiration" - }, - "user_dismissible": { - "$ref": "#/components/schemas/announcement-user-dismissible" + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + } + } } }, "required": [ - "announcement", - "expires_at", - "user_dismissible" + "repository_property" ] }, - "announcement": { - "title": "Enterprise Announcement", - "description": "Enterprise global announcement", + "enterprise-ruleset-conditions-organization-id-target": { + "title": "Repository ruleset conditions for organization IDs", "type": "object", + "description": "Parameters for an organization ID condition", "properties": { - "announcement": { - "$ref": "#/components/schemas/announcement-message" - }, - "expires_at": { - "$ref": "#/components/schemas/announcement-expiration" + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } } }, "required": [ - "announcement" + "organization_id" ] }, - "audit-log-event": { + "enterprise-ruleset-conditions": { + "title": "Enterprise ruleset conditions", "type": "object", - "properties": { - "@timestamp": { - "type": "integer", - "description": "The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "action": { - "type": "string", - "description": "The name of the action that was performed, for example `user.login` or `repo.create`." - }, - "active": { - "type": "boolean" - }, - "active_was": { - "type": "boolean" - }, - "actor": { - "type": "string", - "description": "The actor who performed the action." - }, - "actor_id": { - "type": "integer", - "description": "The id of the actor who performed the action." - }, - "actor_location": { + "description": "Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property.", + "oneOf": [ + { "type": "object", - "properties": { - "country_name": { - "type": "string" + "title": "organization_name_and_repository_name", + "description": "Conditions to target organizations by name and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" } - } + ] }, - "data": { + { "type": "object", - "additionalProperties": true - }, - "org_id": { - "type": "integer" - }, - "user_id": { - "type": "integer" - }, - "business_id": { - "type": "integer" - }, - "blocked_user": { - "type": "string", - "description": "The username of the account being blocked." - }, - "business": { - "type": "string" - }, - "config": { - "type": "array", - "items": { - "type": "object" - } - }, - "config_was": { - "type": "array", - "items": { - "type": "object" - } - }, - "content_type": { - "type": "string" - }, - "operation_type": { - "type": "string" - }, - "created_at": { - "type": "integer", - "description": "The time the audit log event was recorded, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time)." - }, - "deploy_key_fingerprint": { - "type": "string" - }, - "_document_id": { - "type": "string", - "description": "A unique identifier for an audit event." - }, - "emoji": { - "type": "string" - }, - "events": { - "type": "array", - "items": { - "type": "object" - } - }, - "events_were": { - "type": "array", - "items": { - "type": "object" - } - }, - "explanation": { - "type": "string" - }, - "fingerprint": { - "type": "string" - }, - "hook_id": { - "type": "integer" - }, - "limited_availability": { - "type": "boolean" - }, - "message": { - "type": "string" - }, - "name": { - "type": "string" - }, - "old_user": { - "type": "string" - }, - "openssh_public_key": { - "type": "string" - }, - "org": { - "type": "string" - }, - "previous_visibility": { - "type": "string" - }, - "read_only": { - "type": "boolean" - }, - "repo": { - "type": "string", - "description": "The name of the repository." - }, - "repository": { - "type": "string", - "description": "The name of the repository." - }, - "repository_public": { - "type": "boolean" - }, - "target_login": { - "type": "string" - }, - "team": { - "type": "string" - }, - "transport_protocol": { - "type": "integer", - "description": "The type of protocol (for example, HTTP or SSH) used to transfer Git data." - }, - "transport_protocol_name": { - "type": "string", - "description": "A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data." + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] }, - "user": { - "type": "string", - "description": "The user that was affected by the action performed (if available)." + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] }, - "visibility": { - "type": "string", - "description": "The repository visibility, for example `public` or `private`." + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] } - } - }, - "code-scanning-analysis-tool-name": { - "type": "string", - "description": "The name of the tool used to generate the code scanning analysis." - }, - "code-scanning-analysis-tool-guid": { - "nullable": true, - "type": "string", - "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." - }, - "code-scanning-alert-state-query": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "closed", - "dismissed", - "fixed" - ] - }, - "alert-number": { - "type": "integer", - "description": "The security alert number.", - "readOnly": true - }, - "alert-created-at": { - "type": "string", - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "alert-updated-at": { - "type": "string", - "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true - }, - "alert-url": { - "type": "string", - "description": "The REST API URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "alert-html-url": { - "type": "string", - "description": "The GitHub URL of the alert resource.", - "format": "uri", - "readOnly": true - }, - "alert-instances-url": { - "type": "string", - "description": "The REST API URL for fetching the list of instances for an alert.", - "format": "uri", - "readOnly": true - }, - "code-scanning-alert-state": { - "type": "string", - "description": "State of a code scanning alert.", - "enum": [ - "open", - "dismissed", - "fixed" - ] - }, - "alert-fixed-at": { - "type": "string", - "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "alert-dismissed-at": { - "type": "string", - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true - }, - "code-scanning-alert-dismissed-reason": { - "type": "string", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "nullable": true, - "enum": [ - null, - "false positive", - "won't fix", - "used in tests" ] }, - "code-scanning-alert-dismissed-comment": { - "type": "string", - "description": "The dismissal comment associated with the dismissal of the alert.", - "nullable": true, - "maxLength": 280 - }, - "code-scanning-alert-rule-summary": { + "repository-rule-creation": { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "nullable": true, - "type": "string", - "description": "A unique identifier for the rule used to detect the alert." - }, - "name": { + "type": { "type": "string", - "description": "The name of the rule used to detect the alert." - }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, - "severity": { - "nullable": true, + "enum": [ + "creation" + ] + } + } + }, + "repository-rule-update": { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The severity of the alert.", "enum": [ - "none", - "note", - "warning", - "error" + "update" ] }, - "security_severity_level": { - "nullable": true, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + "repository-rule-deletion": { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The security severity of the alert.", "enum": [ - "low", - "medium", - "high", - "critical" + "deletion" ] - }, - "description": { - "type": "string", - "description": "A short description of the rule used to detect the alert." } } }, - "code-scanning-analysis-tool-version": { - "nullable": true, - "type": "string", - "description": "The version of the tool used to generate the code scanning analysis." - }, - "code-scanning-analysis-tool": { + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "name": { - "$ref": "#/components/schemas/code-scanning-analysis-tool-name" - }, - "version": { - "$ref": "#/components/schemas/code-scanning-analysis-tool-version" - }, - "guid": { - "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] } } }, - "code-scanning-ref": { - "type": "string", - "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." - }, - "code-scanning-analysis-analysis-key": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." - }, - "code-scanning-alert-environment": { - "type": "string", - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." - }, - "code-scanning-analysis-category": { - "type": "string", - "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." - }, - "code-scanning-alert-location": { + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", "type": "object", - "description": "Describe a region within a file for the alert.", + "required": [ + "type" + ], "properties": { - "path": { - "type": "string" - }, - "start_line": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "start_column": { - "type": "integer" + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] }, - "end_column": { - "type": "integer" + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] } } }, - "code-scanning-alert-classification": { - "type": "string", - "description": "A classification of the file. For example to identify it as generated.", - "nullable": true, - "enum": [ - "source", - "generated", - "test", - "library" - ] - }, - "code-scanning-alert-instance": { + "repository-rule-required-deployments": { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", "type": "object", + "required": [ + "type" + ], "properties": { - "ref": { - "$ref": "#/components/schemas/code-scanning-ref" - }, - "analysis_key": { - "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" - }, - "environment": { - "$ref": "#/components/schemas/code-scanning-alert-environment" - }, - "category": { - "$ref": "#/components/schemas/code-scanning-analysis-category" - }, - "state": { - "$ref": "#/components/schemas/code-scanning-alert-state" - }, - "commit_sha": { - "type": "string" + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] }, - "message": { + "parameters": { "type": "object", "properties": { - "text": { - "type": "string" + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } } - } - }, - "location": { - "$ref": "#/components/schemas/code-scanning-alert-location" - }, - "html_url": { - "type": "string" - }, - "classifications": { - "type": "array", - "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", - "items": { - "$ref": "#/components/schemas/code-scanning-alert-classification" - } + }, + "required": [ + "required_deployment_environments" + ] } } }, - "simple-repository": { - "title": "Simple Repository", - "description": "A GitHub repository.", + "repository-rule-required-signatures": { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "type": "integer", - "example": 1296269, - "description": "A unique identifier of the repository." - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "description": "The GraphQL identifier of the repository." - }, - "name": { - "type": "string", - "example": "Hello-World", - "description": "The name of the repository." - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World", - "description": "The full, globally unique, name of the repository." - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "type": "boolean", - "description": "Whether the repository is private." - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World", - "description": "The URL to view the repository on GitHub.com." - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true, - "description": "The repository description." - }, - "fork": { - "type": "boolean", - "description": "Whether the repository is a fork." - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World", - "description": "The URL to get more information about the repository from the GitHub API." - }, - "archive_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "description": "A template for the API URL to download the repository as an archive." - }, - "assignees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "description": "A template for the API URL to list the available assignees for issues in the repository." - }, - "blobs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." - }, - "branches_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "description": "A template for the API URL to get information about branches in the repository." - }, - "collaborators_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "description": "A template for the API URL to get information about collaborators of the repository." - }, - "comments_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "description": "A template for the API URL to get information about comments on the repository." - }, - "commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "description": "A template for the API URL to get information about commits on the repository." - }, - "compare_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "description": "A template for the API URL to compare two commits or refs." - }, - "contents_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "description": "A template for the API URL to get the contents of the repository." - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/contributors", - "description": "A template for the API URL to list the contributors to the repository." - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/deployments", - "description": "The API URL to list the deployments of the repository." - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/downloads", - "description": "The API URL to list the downloads on the repository." - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/events", - "description": "The API URL to list the events of the repository." - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/forks", - "description": "The API URL to list the forks of the repository." - }, - "git_commits_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "description": "A template for the API URL to get information about Git commits of the repository." - }, - "git_refs_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "description": "A template for the API URL to get information about Git refs of the repository." - }, - "git_tags_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "description": "A template for the API URL to get information about Git tags of the repository." - }, - "issue_comment_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "description": "A template for the API URL to get information about issue comments on the repository." - }, - "issue_events_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "description": "A template for the API URL to get information about issue events on the repository." - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "description": "A template for the API URL to get information about issues on the repository." - }, - "keys_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "description": "A template for the API URL to get information about deploy keys on the repository." - }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "description": "A template for the API URL to get information about labels of the repository." - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/languages", - "description": "The API URL to get information about the languages of the repository." - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/merges", - "description": "The API URL to merge branches in the repository." - }, - "milestones_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "description": "A template for the API URL to get information about milestones of the repository." - }, - "notifications_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "description": "A template for the API URL to get information about notifications on the repository." - }, - "pulls_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "description": "A template for the API URL to get information about pull requests on the repository." - }, - "releases_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "description": "A template for the API URL to get information about releases on the repository." - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "description": "The API URL to list the stargazers on the repository." - }, - "statuses_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "description": "A template for the API URL to get information about statuses of a commit." - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "description": "The API URL to list the subscribers on the repository." - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/subscription", - "description": "The API URL to subscribe to notifications for this repository." - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/tags", - "description": "The API URL to get information about tags on the repository." - }, - "teams_url": { + "type": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/teams", - "description": "The API URL to list the teams on the repository." + "enum": [ + "required_signatures" + ] + } + } + }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } }, - "trees_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." }, - "hooks_url": { + "reviewer_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/hooks", - "description": "The API URL to list the hooks on the repository." + "description": "Node ID of the team which must review changes to matching files." } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + "file_patterns", + "minimum_approvals", + "reviewer_id" ] }, - "code-scanning-organization-alert-items": { + "repository-rule-pull-request": { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", + "required": [ + "type" + ], "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "$ref": "#/components/schemas/alert-updated-at" - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "instances_url": { - "$ref": "#/components/schemas/alert-instances-url" - }, - "state": { - "$ref": "#/components/schemas/code-scanning-alert-state" - }, - "fixed_at": { - "$ref": "#/components/schemas/alert-fixed-at" - }, - "dismissed_by": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "dismissed_at": { - "$ref": "#/components/schemas/alert-dismissed-at" - }, - "dismissed_reason": { - "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" - }, - "dismissed_comment": { - "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - }, - "rule": { - "$ref": "#/components/schemas/code-scanning-alert-rule-summary" - }, - "tool": { - "$ref": "#/components/schemas/code-scanning-analysis-tool" - }, - "most_recent_instance": { - "$ref": "#/components/schemas/code-scanning-alert-instance" + "type": { + "type": "string", + "enum": [ + "pull_request" + ] }, - "repository": { - "$ref": "#/components/schemas/simple-repository" + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "instances_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool", - "most_recent_instance", - "repository" - ] + } }, - "enterprise-security-analysis-settings": { - "title": "Enterprise Security Analysis Settings", + "repository-rule-params-status-check-configuration": { + "title": "StatusCheckConfiguration", + "description": "Required status check", "type": "object", "properties": { - "advanced_security_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise." - }, - "advanced_security_enabled_for_new_user_namespace_repositories": { - "type": "boolean", - "example": false, - "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories." - }, - "dependabot_alerts_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this\nenterprise." - }, - "secret_scanning_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\nenterprise." - }, - "secret_scanning_push_protection_enabled_for_new_repositories": { - "type": "boolean", - "example": false, - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this enterprise." - }, - "secret_scanning_push_protection_custom_link": { + "context": { "type": "string", - "nullable": true, - "example": "https://github.com/test-org/test-repo/blob/main/README.md", - "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + "description": "The status check context name that must be present on the commit." }, - "secret_scanning_validity_checks_enabled": { - "type": "boolean", - "example": false, - "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise." + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." } }, "required": [ - "advanced_security_enabled_for_new_repositories", - "dependabot_alerts_enabled_for_new_repositories", - "secret_scanning_enabled_for_new_repositories", - "secret_scanning_push_protection_enabled_for_new_repositories" + "context" ] }, - "get-consumed-licenses": { - "title": "Enterprise Consumed Licenses", - "description": "A breakdown of the licenses consumed by an enterprise.", + "repository-rule-required-status-checks": { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], "properties": { - "total_seats_consumed": { - "type": "integer" - }, - "total_seats_purchased": { - "type": "integer" + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] }, - "users": { - "type": "array", - "items": { - "type": "object", - "properties": { - "github_com_login": { - "type": "string" - }, - "github_com_name": { - "type": "string", - "nullable": true - }, - "enterprise_server_user_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "github_com_user": { - "type": "boolean" - }, - "enterprise_server_user": { - "type": "boolean", - "nullable": true - }, - "visual_studio_subscription_user": { - "type": "boolean" - }, - "license_type": { - "type": "string" - }, - "github_com_profile": { - "type": "string", - "nullable": true - }, - "github_com_member_roles": { - "type": "array", - "items": { - "type": "string" - } - }, - "github_com_enterprise_roles": { - "type": "array", - "description": "All enterprise roles for a user.", - "items": { - "type": "string" - } - }, - "github_com_verified_domain_emails": { - "type": "array", - "items": { - "type": "string" - } - }, - "github_com_saml_name_id": { - "type": "string", - "nullable": true - }, - "github_com_orgs_with_pending_invites": { - "type": "array", - "items": { - "type": "string" - } - }, - "github_com_two_factor_auth": { - "type": "boolean", - "nullable": true - }, - "enterprise_server_emails": { - "type": "array", - "items": { - "type": "string" - } - }, - "visual_studio_license_status": { - "type": "string", - "nullable": true - }, - "visual_studio_subscription_email": { - "type": "string", - "nullable": true - }, - "total_user_accounts": { - "type": "integer" + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." } - } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] } } }, - "copilot-usage-metrics": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", + "repository-rule-non-fast-forward": { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "day": { + "type": { "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + "enum": [ + "non_fast_forward" + ] + } + } + }, + "repository-rule-commit-message-pattern": { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + "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-commit-author-email-pattern": { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + "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-committer-email-pattern": { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + "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-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" + ] }, - "breakdown": { - "type": "array", - "description": "Breakdown of Copilot code completions usage by language and editor", - "nullable": true, - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } + "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" + ] } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false + } }, - "dependabot-alert-package": { + "repository-rule-tag-name-pattern": { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", "type": "object", - "description": "Details for the vulnerable package.", - "readOnly": true, - "properties": { - "ecosystem": { - "type": "string", - "description": "The package's language or package management ecosystem.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The unique package name within its ecosystem.", - "readOnly": true - } - }, "required": [ - "ecosystem", - "name" + "type" ], - "additionalProperties": false - }, - "dependabot-alert-security-vulnerability": { - "type": "object", - "description": "Details pertaining to one vulnerable version range for the advisory.", - "readOnly": true, "properties": { - "package": { - "$ref": "#/components/schemas/dependabot-alert-package" - }, - "severity": { + "type": { "type": "string", - "description": "The severity of the vulnerability.", - "readOnly": true, "enum": [ - "low", - "medium", - "high", - "critical" + "tag_name_pattern" ] }, - "vulnerable_version_range": { - "type": "string", - "description": "Conditions that identify vulnerable versions of this vulnerability's package.", - "readOnly": true - }, - "first_patched_version": { + "parameters": { "type": "object", - "description": "Details pertaining to the package version that patches this vulnerability.", - "readOnly": true, - "nullable": true, "properties": { - "identifier": { + "name": { "type": "string", - "description": "The package version that patches this vulnerability.", - "readOnly": true + "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": [ - "identifier" - ], - "additionalProperties": false + "operator", + "pattern" + ] } - }, - "required": [ - "package", - "severity", - "vulnerable_version_range", - "first_patched_version" - ], - "additionalProperties": false + } }, - "dependabot-alert-security-advisory": { + "repository-rule-params-restricted-commits": { + "title": "RestrictedCommits", + "description": "Restricted commit", "type": "object", - "description": "Details for the GitHub Security Advisory.", - "readOnly": true, "properties": { - "ghsa_id": { + "oid": { "type": "string", - "description": "The unique GitHub Security Advisory ID assigned to the advisory.", - "readOnly": true + "description": "Full or abbreviated commit hash to reject" }, - "cve_id": { + "reason": { "type": "string", - "description": "The unique CVE ID assigned to the advisory.", - "readOnly": true, - "nullable": true - }, - "summary": { + "description": "Reason for restriction" + } + }, + "required": [ + "oid" + ] + }, + "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": "A short, plain text summary of the advisory.", - "readOnly": true, - "maxLength": 1024 + "description": "The path to the workflow file" }, - "description": { + "ref": { "type": "string", - "description": "A long-form Markdown-supported description of the advisory.", - "readOnly": true + "description": "The ref (branch or tag) of the workflow file to use" }, - "vulnerabilities": { - "type": "array", - "description": "Vulnerable version range information for the advisory.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" - } + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" }, - "severity": { + "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", - "description": "The severity of the advisory.", - "readOnly": true, "enum": [ - "low", - "medium", - "high", - "critical" + "workflows" ] }, - "cvss": { + "parameters": { "type": "object", - "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", - "readOnly": true, "properties": { - "score": { - "type": "number", - "description": "The overall CVSS score of the advisory.", - "minimum": 0, - "maximum": 10, - "readOnly": true + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, - "vector_string": { - "type": "string", - "description": "The full CVSS vector string for the advisory.", - "readOnly": true, - "nullable": true + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } } }, "required": [ - "score", - "vector_string" - ], - "additionalProperties": false - }, - "cwes": { - "type": "array", - "description": "Details for the advisory pertaining to Common Weakness Enumeration.", - "readOnly": true, - "items": { - "type": "object", - "description": "A CWE weakness assigned to the advisory.", - "readOnly": true, - "properties": { - "cwe_id": { - "type": "string", - "description": "The unique CWE ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The short, plain text name of the CWE.", - "readOnly": true - } - }, - "required": [ - "cwe_id", - "name" - ], - "additionalProperties": false - } - }, - "identifiers": { - "type": "array", - "description": "Values that identify this advisory among security information sources.", - "readOnly": true, - "items": { - "type": "object", - "description": "An advisory identifier.", - "readOnly": true, - "properties": { - "type": { - "type": "string", - "description": "The type of advisory identifier.", - "readOnly": true, - "enum": [ - "CVE", - "GHSA" - ] - }, - "value": { - "type": "string", - "description": "The value of the advisory identifer.", - "readOnly": true - } - }, - "required": [ - "value", - "type" - ], - "additionalProperties": false - } - }, - "references": { - "type": "array", - "description": "Links to additional advisory information.", - "readOnly": true, - "items": { - "type": "object", - "description": "A link to additional advisory information.", - "readOnly": true, - "properties": { - "url": { - "type": "string", - "description": "The URL of the reference.", - "format": "uri", - "readOnly": true - } - }, - "required": [ - "url" - ], - "additionalProperties": false - } - }, - "published_at": { + "workflows" + ] + } + } + }, + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { "type": "string", - "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] }, - "updated_at": { + "security_alerts_threshold": { "type": "string", - "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] }, - "withdrawn_at": { + "tool": { "type": "string", - "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true + "description": "The name of a code scanning tool" } }, "required": [ - "ghsa_id", - "cve_id", - "summary", - "description", - "vulnerabilities", - "severity", - "cvss", - "cwes", - "identifiers", - "references", - "published_at", - "updated_at", - "withdrawn_at" - ], - "additionalProperties": false - }, - "alert-auto-dismissed-at": { - "type": "string", - "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "format": "date-time", - "readOnly": true, - "nullable": true + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] }, - "dependabot-alert-with-repository": { + "repository-rule-code-scanning": { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", "type": "object", - "description": "A Dependabot alert.", + "required": [ + "type" + ], "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "state": { + "type": { "type": "string", - "description": "The state of the Dependabot alert.", - "readOnly": true, "enum": [ - "auto_dismissed", - "dismissed", - "fixed", - "open" + "code_scanning" ] }, - "dependency": { + "parameters": { "type": "object", - "description": "Details for the vulnerable dependency.", - "readOnly": true, "properties": { - "package": { - "$ref": "#/components/schemas/dependabot-alert-package" - }, - "manifest_path": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + "repository-rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The full path to the dependency manifest file, relative to the root of the repository.", - "readOnly": true + "enum": [ + "file_path_restriction" + ] }, - "scope": { + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "description": "The execution scope of the vulnerable dependency.", - "readOnly": true, - "nullable": true, "enum": [ - "development", - "runtime" + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" ] } } }, - "security_advisory": { - "$ref": "#/components/schemas/dependabot-alert-security-advisory" - }, - "security_vulnerability": { - "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } }, - "url": { - "$ref": "#/components/schemas/alert-url" + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" + { + "$ref": "#/components/schemas/repository-rule-workflows" }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + } + ] + }, + "repository-ruleset-conditions-repository-id-target": { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + }, + "org-ruleset-conditions": { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + } + ] }, - "updated_at": { - "$ref": "#/components/schemas/alert-updated-at" + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + } + ] }, - "dismissed_at": { - "$ref": "#/components/schemas/alert-dismissed-at" + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + } + ] + } + ] + }, + "repository-ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" }, - "dismissed_by": { - "$ref": "#/components/schemas/nullable-simple-user" + "name": { + "type": "string", + "description": "The name of the ruleset" }, - "dismissed_reason": { + "target": { "type": "string", - "description": "The reason that the alert was dismissed.", - "nullable": true, + "description": "The target of the ruleset", "enum": [ - "fix_started", - "inaccurate", - "no_bandwidth", - "not_used", - "tolerable_risk" + "branch", + "tag", + "push", + "repository" ] }, - "dismissed_comment": { + "source_type": { "type": "string", - "description": "An optional comment associated with the alert's dismissal.", - "nullable": true, - "maxLength": 280 + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] }, - "fixed_at": { - "$ref": "#/components/schemas/alert-fixed-at" + "source": { + "type": "string", + "description": "The name of the source" }, - "auto_dismissed_at": { - "$ref": "#/components/schemas/alert-auto-dismissed-at" + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - } - }, - "required": [ - "number", - "state", - "dependency", - "security_advisory", - "security_vulnerability", - "url", - "html_url", - "created_at", - "updated_at", - "dismissed_at", - "dismissed_by", - "dismissed_reason", - "dismissed_comment", - "fixed_at", - "repository" - ], - "additionalProperties": false - }, - "get-license-sync-status": { - "title": "License Sync Status", - "description": "Information about the status of a license sync job for an enterprise.", - "properties": { - "server_instances": { + "bypass_actors": { "type": "array", + "description": "The actors that can bypass the rules in this ruleset", "items": { - "type": "object", - "properties": { - "server_id": { - "type": "string" - }, - "hostname": { - "type": "string" - }, - "last_sync": { - "type": "object", - "properties": { - "date": { - "type": "string" - }, - "status": { - "type": "string" - }, - "error": { - "type": "string" - } + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" } } } } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ] + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } } }, @@ -100724,7 +112096,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -100747,6 +112119,25 @@ "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, "resolution_comment": { "type": "string", "description": "The comment that was optionally added when this alert was closed", @@ -100760,6 +112151,16 @@ "inactive", "unknown" ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true } } }, @@ -100928,6 +112329,52 @@ "repositories" ] }, + "get-all-cost-centers": { + "type": "object", + "properties": { + "costCenters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the cost center." + }, + "name": { + "type": "string", + "description": "Name of the cost center." + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource." + } + }, + "required": [ + "type", + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "resources" + ] + } + } + } + }, "packages-billing-usage": { "type": "object", "properties": { @@ -100972,6 +112419,75 @@ "estimated_storage_for_month" ] }, + "billing-usage-report": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + }, "actor": { "title": "Actor", "description": "Actor", @@ -101134,6 +112650,10 @@ "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, "owner": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -101211,10 +112731,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -101308,6 +112824,26 @@ "rocket" ] }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -101524,6 +113060,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -101895,6 +113434,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -101917,6 +113461,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -101967,7 +113514,11 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" }, "node_id": { "type": "string" @@ -102047,6 +113598,11 @@ "format": "email", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -102102,11 +113658,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "private_gists": { "type": "integer", "example": 1 @@ -102316,6 +113867,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -102407,6 +113961,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -102427,6 +113986,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": "string", "nullable": true @@ -102986,6 +114548,24 @@ "192.0.2.1" ] }, + "actions_macos": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "codespaces": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, "dependabot": { "type": "array", "items": { @@ -102995,6 +114575,15 @@ "192.0.2.1" ] }, + "copilot": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, "domains": { "type": "object", "properties": { @@ -103042,6 +114631,49 @@ "example.com" ] } + }, + "actions_inbound": { + "type": "object", + "properties": { + "full_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "wildcard_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + }, + "artifact_attestations": { + "type": "object", + "properties": { + "trust_domain": { + "type": "string", + "example": [ + "example" + ] + }, + "services": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } } } } @@ -103104,6 +114736,30 @@ } } }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -103125,6 +114781,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -103721,7 +115378,7 @@ }, "organization-full": { "title": "Organization Full", - "description": "Organization Full", + "description": "Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement.\nRemoves non-compliant outside collaborators from the organization and its repositories.\n\nGitHub currently defines SMS as an insecure method of two-factor authentication.\n\nIf your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected.", "type": "object", "properties": { "login": { @@ -103861,7 +115518,8 @@ "collaborators": { "type": "integer", "example": 8, - "nullable": true + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", @@ -103948,32 +115606,38 @@ "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -103989,7 +115653,8 @@ "secret_scanning_validity_checks_enabled": { "type": "boolean", "example": false, - "description": "Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "deprecated": true }, "created_at": { "type": "string", @@ -104004,6 +115669,11 @@ "type": "string", "format": "date-time", "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." } }, "required": [ @@ -104135,6 +115805,9 @@ "runners_url": { "type": "string" }, + "hosted_runners_url": { + "type": "string" + }, "inherited": { "type": "boolean" }, @@ -104301,6 +115974,188 @@ "visibility" ] }, + "bypass-response": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + }, + "push-rule-bypass-request": { + "title": "Push rule bypass request", + "description": "A bypass request made by a user asking to be exempted from a push rule in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the bypass request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the bypass request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the bypass request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "nullable": true, + "type": "array", + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated." + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated." + }, + "total_violations": { + "type": "integer", + "description": "The number of rule violations generated from the push associated with this request." + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "open" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the bypass request.", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the bypass request.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/bypass-response" + } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1" + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "example": "https://github.com/octo-org/smile/exemptions/1" + } + } + }, "code-scanning-alert-severity": { "type": "string", "description": "Severity of a code scanning alert.", @@ -104379,6 +116234,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "name": { @@ -104736,8 +116592,8 @@ } }, "copilot-organization-details": { - "title": "Copilot Business Organization Details", - "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business subscription.", + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", "type": "object", "properties": { "seat_breakdown": { @@ -104789,6 +116645,15 @@ "disabled", "unconfigured" ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] } }, "required": [ @@ -104798,405 +116663,6 @@ ], "additionalProperties": true }, - "nullable-team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - }, - "team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "$ref": "#/components/schemas/nullable-team-simple" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "organization": { - "title": "Organization", - "description": "GitHub account for managing multiple users, teams, and repositories", - "type": "object", - "properties": { - "login": { - "description": "Unique login name of the organization", - "example": "new-org", - "type": "string" - }, - "url": { - "description": "URL for the organization", - "example": "https://api.github.com/orgs/github", - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "members_url": { - "type": "string" - }, - "public_members_url": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "blog": { - "description": "Display blog url for the organization", - "example": "blog.example-org.com", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "name": { - "description": "Display name for the organization", - "example": "New Org", - "type": "string" - }, - "company": { - "description": "Display company name for the organization", - "example": "Acme corporation", - "type": "string" - }, - "location": { - "description": "Display location for the organization", - "example": "Berlin, Germany", - "type": "string" - }, - "email": { - "description": "Display email for the organization", - "example": "org@example.com", - "type": "string", - "format": "email" - }, - "has_organization_projects": { - "description": "Specifies if organization projects are enabled for this org", - "type": "boolean" - }, - "has_repository_projects": { - "description": "Specifies if repository projects are enabled for repositories that belong to this org", - "type": "boolean" - }, - "is_verified": { - "type": "boolean" - }, - "public_repos": { - "type": "integer" - }, - "public_gists": { - "type": "integer" - }, - "followers": { - "type": "integer" - }, - "following": { - "type": "integer" - }, - "type": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - } - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] - }, - "copilot-seat-details": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", - "type": "object", - "properties": { - "assignee": { - "type": "object", - "description": "The assignee that has been granted access to GitHub Copilot.", - "additionalProperties": true, - "oneOf": [ - { - "$ref": "#/components/schemas/simple-user" - }, - { - "$ref": "#/components/schemas/team" - }, - { - "$ref": "#/components/schemas/organization" - } - ] - }, - "assigning_team": { - "description": "The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually.", - "oneOf": [ - { - "$ref": "#/components/schemas/team" - } - ], - "nullable": true - }, - "pending_cancellation_date": { - "type": "string", - "format": "date", - "nullable": true, - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": "string", - "nullable": true, - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." - } - }, - "required": [ - "assignee", - "created_at" - ], - "additionalProperties": false - }, "credential-authorization": { "title": "Credential Authorization", "description": "Credential Authorization", @@ -105210,7 +116676,7 @@ "credential_id": { "type": "integer", "example": 1, - "description": "Unique identifier for the credential." + "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key." }, "credential_type": { "type": "string", @@ -105254,7 +116720,8 @@ "authorized_credential_id": { "type": "integer", "nullable": true, - "example": 12345678 + "example": 12345678, + "description": "The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token." }, "authorized_credential_title": { "type": "string", @@ -105419,6 +116886,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -106083,7 +117551,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string", @@ -106245,6 +117714,155 @@ "updated_at" ] }, + "api-insights-route-stats": { + "title": "Route Stats", + "description": "API Insights usage route stats for an actor", + "type": "array", + "items": { + "type": "object", + "properties": { + "http_method": { + "description": "The HTTP method", + "type": "string" + }, + "api_route": { + "description": "The API path's route template", + "type": "string" + }, + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "api-insights-subject-stats": { + "title": "Subject Stats", + "description": "API Insights usage subject stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "subject_type": { + "type": "string" + }, + "subject_name": { + "type": "string" + }, + "subject_id": { + "type": "integer", + "format": "int64" + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "api-insights-summary-stats": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "api-insights-time-stats": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "total_request_count": { + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "api-insights-user-stats": { + "title": "User Stats", + "description": "API Insights usage stats for a user", + "type": "array", + "items": { + "type": "object", + "properties": { + "actor_type": { + "type": "string" + }, + "actor_name": { + "type": "string" + }, + "actor_id": { + "type": "integer", + "format": "int64" + }, + "integration_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "oauth_application_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, "interaction-group": { "type": "string", "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", @@ -106344,192 +117962,607 @@ "organization": { "$ref": "#/components/schemas/organization-simple" }, - "user": { - "$ref": "#/components/schemas/nullable-simple-user" + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + }, + "migration": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 79 + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "guid": { + "type": "string", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516" + }, + "state": { + "type": "string", + "example": "pending" + }, + "lock_repositories": { + "type": "boolean", + "example": true + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octo-org/migrations/79" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2015-07-06T15:33:38-07:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2015-07-06T15:33:38-07:00" + }, + "node_id": { + "type": "string" + }, + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "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\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } + } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ] + }, + "organization-fine-grained-permission": { + "title": "Organization Fine-Grained Permission", + "description": "A fine-grained permission that protects organization resources.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "name", + "description" + ] + }, + "organization-role": { + "title": "Organization Role", + "description": "Organization roles", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the role.", + "type": "string" + }, + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": "string", + "nullable": true + }, + "base_role": { + "type": "string", + "nullable": true, + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin" + ] + }, + "source": { + "type": "string", + "nullable": true, + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined" + ] + }, + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "description": "The date and time the role was created.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time the role was last updated.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "organization-custom-organization-role-create-schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the custom role.", + "type": "string" + }, + "description": { + "description": "A short description about the intended usage of this role or what permissions it grants.", + "type": "string" + }, + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "base_role": { + "description": "The system role from which this role can inherit permissions.", + "type": "string", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin" + ] + } + }, + "required": [ + "name", + "permissions" + ] + }, + "organization-custom-organization-role-update-schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the custom role.", + "type": "string" + }, + "description": { + "description": "A short description about the intended use of this role or the permissions it grants.", + "type": "string" + }, + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "base_role": { + "description": "The system role from which this role can inherit permissions.", + "type": "string", + "enum": [ + "none", + "read", + "triage", + "write", + "maintain", + "admin" + ] + } + } + }, + "team-role-assignment": { + "title": "A Role Assignment for a Team", + "description": "The Relationship a Team has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" }, "permissions": { "type": "object", "properties": { - "can_create_repository": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { "type": "boolean" } }, "required": [ - "can_create_repository" + "pull", + "triage", + "push", + "maintain", + "admin" ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" } }, "required": [ - "state", - "role", - "organization_url", + "id", + "node_id", "url", - "organization", - "user" + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" ] }, - "migration": { - "title": "Migration", - "description": "A migration.", + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the team", "type": "integer", - "example": 79 - }, - "owner": { - "$ref": "#/components/schemas/nullable-simple-user" + "example": 1 }, - "guid": { + "node_id": { "type": "string", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516" + "example": "MDQ6VGVhbTE=" }, - "state": { + "url": { + "description": "URL for the team", "type": "string", - "example": "pending" - }, - "lock_repositories": { - "type": "boolean", - "example": true - }, - "exclude_metadata": { - "type": "boolean" + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" }, - "exclude_git_data": { - "type": "boolean" + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "exclude_attachments": { - "type": "boolean" + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" }, - "exclude_releases": { - "type": "boolean" + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." }, - "exclude_owner_projects": { - "type": "boolean" + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" }, - "org_metadata_only": { - "type": "boolean" + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" }, - "repositories": { - "type": "array", - "description": "The repositories included in the migration. Only returned for export migrations.", - "items": { - "$ref": "#/components/schemas/repository" - } + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" }, - "url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/octo-org/migrations/79" + "example": "https://github.com/orgs/rails/teams/core" }, - "created_at": { + "repositories_url": { "type": "string", - "format": "date-time", - "example": "2015-07-06T15:33:38-07:00" + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "updated_at": { + "slug": { "type": "string", - "format": "date-time", - "example": "2015-07-06T15:33:38-07:00" + "example": "justice-league" }, - "node_id": { + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", "type": "string" - }, - "archive_url": { - "type": "string", - "format": "uri" - }, - "exclude": { - "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\"`.", - "type": "array", - "items": { - "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", - "type": "string" - } } }, "required": [ "id", "node_id", - "owner", - "guid", - "state", - "lock_repositories", - "exclude_metadata", - "exclude_git_data", - "exclude_attachments", - "exclude_releases", - "exclude_owner_projects", - "org_metadata_only", - "repositories", "url", - "created_at", - "updated_at" + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] }, - "organization-fine-grained-permission": { - "title": "Organization Fine-Grained Permission", - "description": "A fine-grained permission that protects organization resources.", + "user-role-assignment": { + "title": "A Role Assignment for a User", + "description": "The Relationship a User has with a role.", "type": "object", "properties": { + "assignment": { + "type": "string", + "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "inherited_from": { + "description": "Team the user has gotten the role through", + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, "name": { + "nullable": true, "type": "string" }, - "description": { + "email": { + "nullable": true, "type": "string" - } - }, - "required": [ - "name", - "description" - ] - }, - "organization-role": { - "title": "Organization Role", - "description": "Organization roles", - "type": "object", - "properties": { + }, + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "description": "The unique identifier of the role.", - "type": "integer" + "type": "integer", + "example": 1 }, - "name": { - "description": "The name of the role.", - "type": "string" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "description": { - "description": "A short description about who this role is for or what permissions it grants.", + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "permissions": { - "description": "A list of permissions included in this role.", - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "organization": { - "$ref": "#/components/schemas/nullable-simple-user" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "created_at": { - "description": "The date and time the role was created.", + "followers_url": { "type": "string", - "format": "date-time" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "updated_at": { - "description": "The date and time the role was last updated.", + "following_url": { "type": "string", - "format": "date-time" + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", - "name", - "permissions", - "organization", - "created_at", - "updated_at" + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ] }, "package-version": { @@ -106700,6 +118733,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -106723,6 +118764,8 @@ "repositories_url", "permissions", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -106735,7 +118778,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." }, "owner": { "$ref": "#/components/schemas/simple-user" @@ -106781,6 +118824,14 @@ "type": "string", "description": "Date and time when the fine-grained personal access token was approved to access the organization." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -106803,852 +118854,337 @@ "repositories_url", "permissions", "access_granted_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" ] }, - "project": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "org-private-registry-configuration": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, "name": { - "description": "Name of the project", - "example": "Week One Sprint", + "description": "The name of the private registry configuration.", + "example": "MAVEN_REPOSITORY_SECRET", "type": "string" }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "example": "monalisa", "type": "string", "nullable": true }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" - }, "created_at": { "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "format": "date-time" } }, "required": [ - "id", - "node_id", - "number", "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "registry_type", + "visibility", "created_at", "updated_at" ] }, - "org-custom-property": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", + "org-private-registry-configuration-with-selected-repositories": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", "type": "object", "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" + "name": { + "description": "The name of the private registry configuration.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" }, - "value_type": { - "type": "string", - "example": "single_select", + "registry_type": { + "description": "The registry type.", "enum": [ - "string", - "single_select" + "maven_repository" ], - "description": "The type of the value for the property" + "type": "string" }, - "required": { - "type": "boolean", - "description": "Whether the property is required." + "username": { + "description": "The username to use when authenticating with the private registry.", + "example": "monalisa", + "type": "string" }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "enum": [ + "all", + "private", + "selected" ], - "nullable": true, - "description": "Default value of the property" - }, - "description": { - "type": "string", - "nullable": true, - "description": "Short description of the property" + "type": "string" }, - "allowed_values": { + "selected_repository_ids": { "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "nullable": true, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": "string", - "nullable": true, - "enum": [ - "org_actors", - "org_and_repo_actors" - ], - "example": "org_actors", - "description": "Who can edit the 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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "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 + "type": "integer" + } }, - "repository_name": { + "created_at": { "type": "string", - "example": "Hello-World" + "format": "date-time" }, - "repository_full_name": { + "updated_at": { "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" + "format": "date-time" } }, "required": [ - "repository_id", - "repository_name", - "repository_full_name", - "properties" + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" ] }, - "nullable-repository": { - "title": "Repository", - "description": "A repository on GitHub.", + "project": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { + "owner_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" + "example": "https://api.github.com/repos/api-playground/projects-test" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/projects/1002604" }, - "teams_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "https://github.com/api-playground/projects-test/projects/12" }, - "mirror_url": { + "columns_url": { "type": "string", "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/projects/1002604/columns" }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "id": { + "type": "integer", + "example": 1002604 }, - "svn_url": { + "node_id": { "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "example": "MDc6UHJvamVjdDEwMDI2MDQ=" }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true + "name": { + "description": "Name of the project", + "example": "Week One Sprint", + "type": "string" }, - "language": { + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", "type": "string", "nullable": true }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { + "number": { "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true, - "deprecated": true - }, - "has_discussions": { - "description": "Whether discussions are enabled.", - "default": false, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "example": 1 }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", "type": "string" }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" }, "created_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_auto_merge": { - "description": "Whether to allow Auto-merge to be used on pull requests.", - "default": false, - "type": "boolean", - "example": false - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_update_branch": { - "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", - "default": false, - "type": "boolean", - "example": false - }, - "use_squash_pr_title_as_default": { - "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "default": false, - "deprecated": true - }, - "squash_merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." - }, - "squash_merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." - }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." - }, - "merge_commit_message": { - "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "allow_forking": { - "description": "Whether to allow forking this repo", - "type": "boolean" - }, - "web_commit_signoff_required": { - "description": "Whether to require contributors to sign off on web-based commits", - "default": false, - "type": "boolean" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" + "example": "2011-04-10T20:09:31Z" }, - "starred_at": { + "updated_at": { "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "anonymous_access_enabled": { - "type": "boolean", - "description": "Whether anonymous git access is enabled for this repository" + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", + "number", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "body", + "state", "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", "updated_at" - ], - "nullable": true + ] }, - "code-of-conduct-simple": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", "type": "object", "properties": { - "url": { + "property_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" + "description": "The name of the property" }, - "key": { - "type": "string", - "example": "citizen_code_of_conduct" + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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 }, - "name": { + "repository_name": { "type": "string", - "example": "Citizen Code of Conduct" + "example": "Hello-World" }, - "html_url": { + "repository_full_name": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + "example": "octocat/Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" } }, "required": [ - "url", - "key", - "name", - "html_url" + "repository_id", + "repository_name", + "repository_full_name", + "properties" ] }, - "full-repository": { - "title": "Full Repository", - "description": "Full Repository", + "nullable-repository": { + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer", - "example": 1296269 + "format": "int64" }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "Hello-World" + "example": "Team Environment" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, "owner": { "$ref": "#/components/schemas/simple-user" }, "private": { + "description": "Whether the repository is private or public.", + "default": false, "type": "boolean" }, "html_url": { @@ -107877,6 +119413,7 @@ "example": 108 }, "default_branch": { + "description": "The default branch of the repository.", "type": "string", "example": "master" }, @@ -107885,6 +119422,8 @@ "example": 0 }, "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, "type": "boolean", "example": true }, @@ -107892,23 +119431,23 @@ "type": "array", "items": { "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] + } }, "has_issues": { + "description": "Whether issues are enabled.", + "default": true, "type": "boolean", "example": true }, "has_projects": { + "description": "Whether projects are enabled.", + "default": true, "type": "boolean", "example": true }, "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, "type": "boolean", "example": true }, @@ -107916,14 +119455,21 @@ "type": "boolean" }, "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, "type": "boolean", - "example": true + "example": true, + "deprecated": true }, "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, "type": "boolean", "example": true }, "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, "disabled": { @@ -107932,87 +119478,68 @@ }, "visibility": { "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" + "default": "public", + "type": "string" }, "pushed_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:06:43Z" + "example": "2011-01-26T19:06:43Z", + "nullable": true }, "created_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:01:12Z" + "example": "2011-01-26T19:01:12Z", + "nullable": true }, "updated_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "example": "2011-01-26T19:14:43Z", + "nullable": true }, "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, "type": "boolean", "example": true }, - "template_repository": { - "$ref": "#/components/schemas/nullable-repository" - }, "temp_clone_token": { - "type": "string", - "nullable": true + "type": "string" }, "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, "type": "boolean", "example": true }, "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, "type": "boolean", "example": false }, "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, "type": "boolean", "example": false }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, "type": "boolean", - "example": true + "example": false }, "use_squash_pr_title_as_default": { "type": "boolean", - "example": false + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", - "example": "PR_TITLE", "enum": [ "PR_TITLE", "COMMIT_OR_PR_TITLE" @@ -108021,7 +119548,6 @@ }, "squash_merge_commit_message": { "type": "string", - "example": "PR_BODY", "enum": [ "PR_BODY", "COMMIT_MESSAGES", @@ -108031,16 +119557,14 @@ }, "merge_commit_title": { "type": "string", - "example": "PR_TITLE", "enum": [ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", - "example": "PR_BODY", "enum": [ "PR_BODY", "PR_TITLE", @@ -108048,39 +119572,20 @@ ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, - "allow_forking": { + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, "type": "boolean", "example": true }, - "web_commit_signoff_required": { - "type": "boolean", - "example": false - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "organization": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "parent": { - "$ref": "#/components/schemas/repository" - }, - "source": { - "$ref": "#/components/schemas/repository" - }, - "forks": { - "type": "integer" + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" }, - "master_branch": { - "type": "string" + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" }, "open_issues": { "type": "integer" @@ -108088,21 +119593,16 @@ "watchers": { "type": "integer" }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" - }, - "code_of_conduct": { - "$ref": "#/components/schemas/code-of-conduct-simple" + "master_branch": { + "type": "string" }, - "security_and_analysis": { - "$ref": "#/components/schemas/security-and-analysis" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } }, "required": [ @@ -108157,11 +119657,11 @@ "forks", "forks_count", "git_url", + "has_downloads", "has_issues", "has_projects", "has_wiki", "has_pages", - "has_discussions", "homepage", "language", "archived", @@ -108178,1109 +119678,601 @@ "watchers", "watchers_count", "created_at", - "updated_at", - "network_count", - "subscribers_count" - ] - }, - "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.", - "enum": [ - "disabled", - "active", - "evaluate" - ] - }, - "repository-ruleset-bypass-actor": { - "title": "Repository Ruleset Bypass Actor", - "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type", - "bypass_mode" - ], - "properties": { - "actor_id": { - "type": "integer", - "nullable": true, - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\n" - }, - "actor_type": { - "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey" - ], - "description": "The type of actor that can bypass a ruleset.\n" - }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\n", - "enum": [ - "always", - "pull_request" - ] - } - } - }, - "repository-ruleset-conditions": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - "repository-ruleset-conditions-repository-name-target": { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." - } - } - } - }, - "required": [ - "repository_name" - ] - }, - "repository-ruleset-conditions-repository-id-target": { - "title": "Repository ruleset conditions for repository IDs", - "type": "object", - "description": "Parameters for a repository ID condition", - "properties": { - "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } - } - }, - "required": [ - "repository_id" - ] - }, - "repository-ruleset-conditions-repository-property-spec": { - "title": "Repository ruleset property targeting definition", - "type": "object", - "description": "Parameters for a targeting a repository property", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository property to target" - }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } - } - }, - "required": [ - "name", - "property_values" - ] - }, - "repository-ruleset-conditions-repository-property-target": { - "title": "Repository ruleset conditions for repository properties", - "type": "object", - "description": "Parameters for a repository property condition", - "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - } - } - } - } - }, - "required": [ - "repository_property" - ] - }, - "org-ruleset-conditions": { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\n", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - } - ] - }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" - } - ] - }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - } - ] - } - ] - }, - "repository-rule-creation": { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - "repository-rule-update": { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - "repository-rule-deletion": { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - "repository-rule-required-linear-history": { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - "repository-rule-required-deployments": { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - "repository-rule-required-signatures": { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - "repository-rule-pull-request": { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - "repository-rule-params-status-check-configuration": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - }, - "repository-rule-required-status-checks": { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - "repository-rule-non-fast-forward": { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - "repository-rule-commit-message-pattern": { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_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-commit-author-email-pattern": { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_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-committer-email-pattern": { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_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-branch-name-pattern": { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" + "updated_at" ], - "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" - ] - } - } + "nullable": true }, - "repository-rule-tag-name-pattern": { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "url": { "type": "string", - "enum": [ - "tag_name_pattern" - ] + "format": "uri", + "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" }, - "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-restricted-commits": { - "title": "RestrictedCommits", - "description": "Restricted commit", - "type": "object", - "properties": { - "oid": { + "key": { "type": "string", - "description": "Full or abbreviated commit hash to reject" + "example": "citizen_code_of_conduct" }, - "reason": { + "name": { "type": "string", - "description": "Reason for restriction" + "example": "Citizen Code of Conduct" + }, + "html_url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" } }, "required": [ - "oid" + "url", + "key", + "name", + "html_url" ] }, - "repository-rule-params-workflow-file-reference": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", + "full-repository": { + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "path": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { "type": "string", - "description": "The path to the workflow file" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "ref": { + "name": { "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" + "example": "Hello-World" }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "sha": { + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_url": { "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": { + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { "type": "string", - "enum": [ - "workflows" - ] + "example": "This your first repo!", + "nullable": true }, - "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-params-code-scanning-tool": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "security_alerts_threshold": { + "archive_url": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "tool": { + "assignees_url": { "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - }, - "repository-rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "$ref": "#/components/schemas/repository-rule-creation" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - { - "$ref": "#/components/schemas/repository-rule-update" + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-deletion" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - { - "$ref": "#/components/schemas/repository-rule-required-linear-history" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - { - "$ref": "#/components/schemas/repository-rule-required-deployments" + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - { - "$ref": "#/components/schemas/repository-rule-required-signatures" + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - { - "$ref": "#/components/schemas/repository-rule-pull-request" + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - { - "$ref": "#/components/schemas/repository-rule-required-status-checks" + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - { - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - { - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - { - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - { - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - { - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - { - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - { - "title": "file_path_restriction", - "description": "Note: file_path_restriction is in beta and subject to change.\n\nPrevent commits that include changes in specified file paths from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - { - "title": "max_file_path_length", - "description": "Note: max_file_path_length is in beta and subject to change.\n\nPrevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths", - "minimum": 1, - "maximum": 256 - } - }, - "required": [ - "max_file_path_length" - ] - } - } + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - { - "title": "file_extension_restriction", - "description": "Note: file_extension_restriction is in beta and subject to change.\n\nPrevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - { - "title": "max_file_size", - "description": "Note: max_file_size is in beta and subject to change.\n\nPrevent commits that exceed a specified file size limit from being pushed to the commit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - { - "$ref": "#/components/schemas/repository-rule-workflows" - } - ] - }, - "repository-ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "name": { + "issues_url": { "type": "string", - "description": "The name of the ruleset" + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "target": { + "keys_url": { "type": "string", - "description": "The target of the ruleset\n\n**Note**: The `push` target is in beta and is subject to change.", - "enum": [ - "branch", - "tag", - "push" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "source_type": { + "labels_url": { "type": "string", - "description": "The type of the source of the ruleset", - "enum": [ - "Repository", - "Organization" - ] + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "source": { + "languages_url": { "type": "string", - "description": "The name of the source" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "enforcement": { - "$ref": "#/components/schemas/repository-rule-enforcement" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "bypass_actors": { + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "type": "boolean", + "example": true + }, + "topics": { "type": "array", - "description": "The actors that can bypass the rules in this ruleset", "items": { - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - } + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "current_user_can_bypass": { + "has_issues": { + "type": "boolean", + "example": true + }, + "has_projects": { + "type": "boolean", + "example": true + }, + "has_wiki": { + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": true + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" - ] + "example": "public" }, - "node_id": { - "type": "string" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" }, - "_links": { + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { "type": "object", "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } + "admin": { + "type": "boolean" }, - "html": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } - } - } - }, - "conditions": { - "nullable": true, - "anyOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" + "maintain": { + "type": "boolean" }, - { - "$ref": "#/components/schemas/org-ruleset-conditions" + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } + }, + "required": [ + "admin", + "pull", + "push" ] }, - "rules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository-rule" - } + "allow_rebase_merge": { + "type": "boolean", + "example": true }, - "created_at": { + "template_repository": { + "$ref": "#/components/schemas/nullable-repository" + }, + "temp_clone_token": { "type": "string", - "format": "date-time" + "nullable": true }, - "updated_at": { + "allow_squash_merge": { + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "type": "boolean", + "example": true + }, + "allow_update_branch": { + "type": "boolean", + "example": true + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { "type": "string", - "format": "date-time" + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_forking": { + "type": "boolean", + "example": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer", + "example": 42 + }, + "network_count": { + "type": "integer", + "example": 0 + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "parent": { + "$ref": "#/components/schemas/repository" + }, + "source": { + "$ref": "#/components/schemas/repository" + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "$ref": "#/components/schemas/code-of-conduct-simple" + }, + "security_and_analysis": { + "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ] }, "rule-suites": { "title": "Rule Suites", @@ -109339,7 +120331,8 @@ "type": "string", "enum": [ "pass", - "fail" + "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`." } @@ -109401,11 +120394,13 @@ }, "evaluation_result": { "type": "string", + "nullable": true, "enum": [ "pass", - "fail" + "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`." + "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`. Null if no rules with `evaluate` enforcement status were run." }, "rule_evaluations": { "type": "array", @@ -109455,7 +120450,8 @@ }, "details": { "type": "string", - "description": "Any associated details with the rule evaluation." + "nullable": true, + "description": "The detailed failure message for the rule. Null if the rule passed." } } } @@ -109723,6 +120719,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "nullable": true, @@ -109835,89 +120834,6 @@ ], "additionalProperties": false }, - "team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "example": "notifications_enabled" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - }, "group-mapping": { "title": "GroupMapping", "description": "External Groups to be mapped to a team for membership", @@ -111241,7 +122157,8 @@ "id": { "description": "The project card's ID", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -111438,6 +122355,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -111968,7 +122888,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -111989,7 +122910,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -112024,7 +122946,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -112476,8 +123399,9 @@ "properties": { "id": { "description": "The id of the environment.", - "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 56780428 }, "node_id": { "type": "string", @@ -112558,8 +123482,9 @@ }, "id": { "description": "Unique identifier of the deployment", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 42 }, "node_id": { "type": "string", @@ -113201,7 +124126,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -113250,6 +124176,9 @@ }, "site_admin": { "type": "boolean" + }, + "user_view_type": { + "type": "string" } } } @@ -113399,12 +124328,19 @@ "site_admin": { "type": "boolean", "example": false + }, + "user_view_type": { + "type": "string", + "example": "public" } } }, "name": { "type": "string" }, + "client_id": { + "type": "string" + }, "description": { "type": "string" }, @@ -113646,6 +124582,10 @@ "signature": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -113811,10 +124751,26 @@ ] }, "author": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "committer": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "parents": { "type": "array", @@ -114309,7 +125265,8 @@ "id": { "description": "The id of the check.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "head_sha": { "description": "The SHA of the commit that is being checked.", @@ -114609,7 +125566,8 @@ "properties": { "id": { "type": "integer", - "example": 5 + "example": 5, + "format": "int64" }, "node_id": { "type": "string", @@ -114871,7 +125829,7 @@ }, "full_description": { "type": "string", - "description": "description of the rule used to detect the alert." + "description": "A description of the rule used to detect the alert." }, "tags": { "nullable": true, @@ -114965,6 +125923,74 @@ "dismissed" ] }, + "code-scanning-autofix-status": { + "type": "string", + "description": "The status of an autofix.", + "enum": [ + "pending", + "error", + "success", + "outdated" + ] + }, + "code-scanning-autofix-description": { + "type": "string", + "description": "The description of an autofix.", + "nullable": true + }, + "code-scanning-autofix-started-at": { + "type": "string", + "description": "The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "code-scanning-autofix": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/code-scanning-autofix-status" + }, + "description": { + "$ref": "#/components/schemas/code-scanning-autofix-description" + }, + "started_at": { + "$ref": "#/components/schemas/code-scanning-autofix-started-at" + } + }, + "required": [ + "status", + "description", + "started_at" + ] + }, + "code-scanning-autofix-commits": { + "description": "Commit an autofix for a code scanning alert", + "type": "object", + "properties": { + "target_ref": { + "description": "The Git reference of target branch for the commit. Branch needs to already exist. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "type": "string" + }, + "message": { + "description": "Commit message to be used.", + "type": "string" + } + }, + "nullable": true + }, + "code-scanning-autofix-commits-response": { + "type": "object", + "properties": { + "target_ref": { + "type": "string", + "description": "The Git reference of target branch for the commit. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." + }, + "sha": { + "type": "string", + "description": "SHA of commit with autofix." + } + } + }, "code-scanning-analysis-sarif-id": { "type": "string", "description": "An identifier for the upload.", @@ -115151,6 +126177,278 @@ "url" ] }, + "code-scanning-variant-analysis-language": { + "type": "string", + "description": "The language targeted by the CodeQL query", + "enum": [ + "cpp", + "csharp", + "go", + "java", + "javascript", + "python", + "ruby", + "swift" + ] + }, + "code-scanning-variant-analysis-repository": { + "title": "Repository Identifier", + "description": "Repository Identifier", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + } + }, + "required": [ + "full_name", + "id", + "name", + "private", + "stargazers_count", + "updated_at" + ] + }, + "code-scanning-variant-analysis-status": { + "type": "string", + "description": "The new status of the CodeQL variant analysis repository task.", + "enum": [ + "pending", + "in_progress", + "succeeded", + "failed", + "canceled", + "timed_out" + ] + }, + "code-scanning-variant-analysis-skipped-repo-group": { + "type": "object", + "properties": { + "repository_count": { + "type": "integer", + "description": "The total number of repositories that were skipped for this reason.", + "example": 2 + }, + "repositories": { + "type": "array", + "description": "A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it.", + "items": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" + } + } + }, + "required": [ + "repository_count", + "repositories" + ] + }, + "code-scanning-variant-analysis": { + "title": "Variant Analysis", + "description": "A run of a CodeQL query against one or more repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the variant analysis." + }, + "controller_repo": { + "$ref": "#/components/schemas/simple-repository" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "query_language": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-language" + }, + "query_pack_url": { + "type": "string", + "description": "The download url for the query pack." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "completed_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "succeeded", + "failed", + "cancelled" + ] + }, + "actions_workflow_run_id": { + "type": "integer", + "description": "The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started." + }, + "failure_reason": { + "type": "string", + "enum": [ + "no_repos_queried", + "actions_workflow_run_failed", + "internal_error" + ], + "description": "The reason for a failure of the variant analysis. This is only available if the variant analysis has failed." + }, + "scanned_repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "repository": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" + }, + "analysis_status": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-status" + }, + "result_count": { + "type": "integer", + "description": "The number of results in the case of a successful analysis. This is only available for successful analyses." + }, + "artifact_size_in_bytes": { + "type": "integer", + "description": "The size of the artifact. This is only available for successful analyses." + }, + "failure_message": { + "type": "string", + "description": "The reason of the failure of this repo task. This is only available if the repository task has failed." + } + }, + "required": [ + "repository", + "analysis_status" + ] + } + }, + "skipped_repositories": { + "type": "object", + "description": "Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis.", + "properties": { + "access_mismatch_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + }, + "not_found_repos": { + "type": "object", + "properties": { + "repository_count": { + "type": "integer", + "description": "The total number of repositories that were skipped for this reason.", + "example": 2 + }, + "repository_full_names": { + "type": "array", + "description": "A list of full repository names that were skipped. This list may not include all repositories that were skipped.", + "items": { + "type": "string" + } + } + }, + "required": [ + "repository_count", + "repository_full_names" + ] + }, + "no_codeql_db_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + }, + "over_limit_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + } + }, + "required": [ + "access_mismatch_repos", + "not_found_repos", + "no_codeql_db_repos", + "over_limit_repos" + ] + } + }, + "required": [ + "id", + "controller_repo", + "actor", + "query_language", + "query_pack_url", + "status" + ] + }, + "code-scanning-variant-analysis-repo-task": { + "type": "object", + "properties": { + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "analysis_status": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-status" + }, + "artifact_size_in_bytes": { + "type": "integer", + "description": "The size of the artifact. This is only available for successful analyses." + }, + "result_count": { + "type": "integer", + "description": "The number of results in the case of a successful analysis. This is only available for successful analyses." + }, + "failure_message": { + "type": "string", + "description": "The reason of the failure of this repo task. This is only available if the repository task has failed." + }, + "database_commit_sha": { + "type": "string", + "description": "The SHA of the commit the CodeQL database was built against. This is only available for successful analyses." + }, + "source_location_prefix": { + "type": "string", + "description": "The source location prefix to use. This is only available for successful analyses." + }, + "artifact_url": { + "type": "string", + "description": "The URL of the artifact. This is only available for successful analyses." + } + }, + "required": [ + "repository", + "analysis_status" + ] + }, "code-scanning-default-setup": { "description": "Configuration for code scanning default setup.", "type": "object", @@ -115169,6 +126467,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -115182,6 +126481,21 @@ ] } }, + "runner_type": { + "description": "Runner type to be used.", + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled" + ] + }, + "runner_label": { + "description": "Runner label to be used if the runner type is labeled.", + "nullable": true, + "type": "string", + "example": "code-scanning" + }, "query_suite": { "description": "CodeQL query suite to be used.", "type": "string", @@ -115219,6 +126533,20 @@ "not-configured" ] }, + "runner_type": { + "description": "Runner type to be used.", + "type": "string", + "enum": [ + "standard", + "labeled" + ] + }, + "runner_label": { + "nullable": true, + "description": "Runner label to be used if the runner type is labeled.", + "type": "string", + "example": "code-scanning" + }, "query_suite": { "description": "CodeQL query suite to be used.", "type": "string", @@ -115233,6 +126561,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -115315,6 +126644,29 @@ } } }, + "code-security-configuration-for-repository": { + "type": "object", + "description": "Code security configuration associated with a repository and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, "codeowners-errors": { "title": "CODEOWNERS errors", "description": "A list of errors found in a repo's CODEOWNERS file", @@ -115484,6 +126836,223 @@ }, "id": { "type": "integer", + "format": "int64", + "example": 1 + }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "role_name" + ] + }, + "repository-invitation": { + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository invitation.", + "example": 42, + "type": "integer", + "format": "int64" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "invitee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "inviter": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "permissions": { + "description": "The permission associated with the invitation.", + "example": "read", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-06-13T14:52:50-05:00" + }, + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" + }, + "url": { + "description": "URL for the repository invitation", + "example": "https://api.github.com/user/repository-invitations/1", + "type": "string" + }, + "html_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World/invitations" + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", + "url", + "html_url", + "created_at" + ] + }, + "nullable-collaborator": { + "title": "Collaborator", + "description": "Collaborator", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -115594,216 +127163,10 @@ "role_name": { "type": "string", "example": "admin" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url", - "role_name" - ] - }, - "repository-invitation": { - "title": "Repository Invitation", - "description": "Repository invitations let you manage who you collaborate with.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository invitation.", - "example": 42, - "type": "integer" - }, - "repository": { - "$ref": "#/components/schemas/minimal-repository" - }, - "invitee": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "inviter": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "permissions": { - "description": "The permission associated with the invitation.", - "example": "read", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "triage", - "maintain" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-06-13T14:52:50-05:00" - }, - "expired": { - "description": "Whether or not the invitation has expired", - "type": "boolean" - }, - "url": { - "description": "URL for the repository invitation", - "example": "https://api.github.com/user/repository-invitations/1", - "type": "string" - }, - "html_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World/invitations" - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "permissions", - "inviter", - "invitee", - "repository", - "url", - "html_url", - "created_at" - ] - }, - "nullable-collaborator": { - "title": "Collaborator", - "description": "Collaborator", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "email": { - "nullable": true, - "type": "string" - }, - "name": { - "nullable": true, - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "push", - "admin" - ] }, - "role_name": { + "user_view_type": { "type": "string", - "example": "admin" + "example": "public" } }, "required": [ @@ -116014,6 +127377,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -116714,6 +128078,9 @@ "sha": { "type": "string" }, + "content": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -116750,9 +128117,6 @@ "path": { "type": "string" }, - "content": { - "type": "string" - }, "sha": { "type": "string" }, @@ -116849,9 +128213,7 @@ "sha", "size", "type", - "url", - "content", - "encoding" + "url" ] }, "content-directory": { @@ -117354,6 +128716,53 @@ "payload": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true + } + } + } + } + } + } + }, + "secret-scanning-push-protection-bypass-placeholder-id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "repository-rule-violation-error": { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + }, + "token_type": { + "type": "string" + } + } + } } } } @@ -117437,6 +128846,9 @@ }, "name": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -117696,6 +129108,11 @@ "example": "SPDX-2.3", "description": "The version of the SPDX specification that this document conforms to." }, + "comment": { + "type": "string", + "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/", + "description": "An optional comment about the SPDX document." + }, "creationInfo": { "type": "object", "properties": { @@ -117728,17 +129145,9 @@ "example": "CC0-1.0", "description": "The license under which the SPDX document is licensed." }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "example": "github/github" - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", - "example": "https://github.com/example/dependency_graph/sbom-123", + "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "description": "The namespace for the SPDX document." }, "packages": { @@ -117753,7 +129162,7 @@ }, "name": { "type": "string", - "example": "rubygems:github/github", + "example": "github/github", "description": "The name of the package." }, "versionInfo": { @@ -117786,6 +129195,11 @@ "example": "NOASSERTION", "description": "The distribution source of this package, or NOASSERTION if this was not determined." }, + "copyrightText": { + "type": "string", + "example": "Copyright (c) 1985 GitHub.com", + "description": "The copyright holders of the package, and any dates present with those notices, if available." + }, "externalRefs": { "type": "array", "items": { @@ -117821,8 +129235,33 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "example": "DEPENDS_ON", + "description": "The type of relationship between the two SPDX elements." + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -117832,7 +129271,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -118051,6 +129489,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -118088,7 +129527,7 @@ "example": "production" }, "target_url": { - "description": "Deprecated: the URL to associate with this status.", + "description": "Closing down notice: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", @@ -118178,7 +129617,8 @@ "id": { "description": "The id of the environment.", "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -118654,6 +130094,10 @@ "payload": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -119423,6 +130867,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -120682,6 +132129,7 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 @@ -120702,6 +132150,7 @@ "type": "string" }, "description": { + "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true @@ -120712,6 +132161,7 @@ "type": "string" }, "default": { + "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } @@ -120984,6 +132434,10 @@ "payload": { "type": "string", "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -121127,14 +132581,16 @@ }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", - "example": 42, "type": "integer", + "format": "int64", + "example": 42, "nullable": true }, "id": { "description": "The ID of the pull request review comment.", - "example": 1, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { "description": "The node ID of the pull request review comment.", @@ -121152,12 +132608,12 @@ "type": "string" }, "position": { - "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", + "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", "example": 1, "type": "integer" }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", + "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", "example": 4, "type": "integer" }, @@ -121638,6 +133094,9 @@ "last_used": { "type": "string", "nullable": true + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -122401,6 +133860,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -122442,745 +133902,162 @@ "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" }, "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" - }, - "statuses_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" - }, - "number": { - "description": "Number uniquely identifying the pull request within its repository.", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of this Pull Request. Either `open` or `closed`.", - "enum": [ - "open", - "closed" - ], - "example": "open", - "type": "string" - }, - "locked": { - "type": "boolean", - "example": true - }, - "title": { - "description": "The title of the pull request.", - "example": "Amazing new feature", - "type": "string" - }, - "user": { - "$ref": "#/components/schemas/simple-user" - }, - "body": { - "type": "string", - "example": "Please pull these awesome changes", - "nullable": true - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "$ref": "#/components/schemas/nullable-milestone" - }, - "active_lock_reason": { - "type": "string", - "example": "too heated", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "merged_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "merge_commit_sha": { - "type": "string", - "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "nullable": true - }, - "assignee": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "requested_reviewers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "requested_teams": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-simple" - }, - "nullable": true - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "type": "object", - "nullable": true, - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "spdx_id": { - "type": "string", - "nullable": true - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": [ + "open", + "closed" + ], + "example": "open", + "type": "string" + }, + "locked": { + "type": "boolean", + "example": true + }, + "title": { + "description": "The title of the pull request.", + "example": "Amazing new feature", + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "body": { + "type": "string", + "example": "Please pull these awesome changes", + "nullable": true + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "active_lock_reason": { + "type": "string", + "example": "too heated", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merged_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merge_commit_sha": { + "type": "string", + "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "nullable": true + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true + }, + "requested_teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + }, + "nullable": true + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -123201,567 +134078,13 @@ "type": "string" }, "repo": { - "type": "object", - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -123969,7 +134292,8 @@ "id": { "description": "Unique identifier of the review", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -124073,11 +134397,13 @@ }, "pull_request_review_id": { "type": "integer", + "format": "int64", "example": 42, "nullable": true }, "id": { "type": "integer", + "format": "int64", "example": 10 }, "node_id": { @@ -124514,6 +134840,16 @@ } ] }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, { "allOf": [ { @@ -124623,6 +134959,16 @@ "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } ] }, @@ -124675,7 +135021,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -124695,6 +135041,25 @@ "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -124703,6 +135068,16 @@ "inactive", "unknown" ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true } } }, @@ -124923,7 +135298,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -124938,7 +135313,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -125058,6 +135433,105 @@ } } }, + "secret-scanning-push-protection-bypass-reason": { + "description": "The reason for bypassing push protection.", + "type": "string", + "enum": [ + "false_positive", + "used_in_tests", + "will_fix_later" + ] + }, + "secret-scanning-push-protection-bypass": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "expire_at": { + "type": "string", + "format": "date-time", + "description": "The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "token_type": { + "type": "string", + "description": "The token type this bypass is for." + } + } + }, + "secret-scanning-scan": { + "description": "Information on a single scan performed by secret scanning on the repository", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of scan" + }, + "status": { + "type": "string", + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time that the scan was completed. Empty if the scan is running", + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true + } + } + }, + "secret-scanning-scan-history": { + "type": "object", + "properties": { + "incremental_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "pattern_update_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "backfill_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "custom_pattern_backfill_scans": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/secret-scanning-scan" + }, + { + "type": "object", + "properties": { + "pattern_name": { + "type": "string", + "description": "Name of the custom pattern for custom pattern scans" + }, + "pattern_scope": { + "type": "string", + "description": "Level at which the custom pattern is defined, one of \"repository\", \"organization\", or \"enterprise\"" + } + } + } + ] + } + } + } + }, "repository-advisory-create": { "type": "object", "properties": { @@ -127036,6 +137510,26 @@ } } }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "type": "string" }, @@ -127743,7 +138237,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -127861,6 +138356,9 @@ "type": "string", "format": "date-time", "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127896,8 +138394,12 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, + "user_view_type": { + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -127996,6 +138498,12 @@ "example": "octocat@github.com", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -128083,11 +138591,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "business_plus": { "type": "boolean" }, @@ -128255,6 +138758,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "name": { @@ -128532,6 +139036,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 3 }, "name": { @@ -128593,7 +139098,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "primary_key_id": { "type": "integer" @@ -128710,7 +139216,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -128893,6 +139400,114 @@ "repo" ] }, + "sigstore-bundle-0": { + "title": "Sigstore Bundle v0.1", + "description": "Sigstore Bundle v0.1", + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": { + "x509CertificateChain": { + "type": "object", + "properties": { + "certificates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rawBytes": { + "type": "string" + } + } + } + } + } + }, + "tlogEntries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "logIndex": { + "type": "string" + }, + "logId": { + "type": "object", + "properties": { + "keyId": { + "type": "string" + } + } + }, + "kindVersion": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "integratedTime": { + "type": "string" + }, + "inclusionPromise": { + "type": "object", + "properties": { + "signedEntryTimestamp": { + "type": "string" + } + } + }, + "inclusionProof": { + "type": "string", + "nullable": true + }, + "canonicalizedBody": { + "type": "string" + } + } + } + }, + "timestampVerificationData": { + "type": "string", + "nullable": true + } + } + }, + "dsseEnvelope": { + "type": "object", + "properties": { + "payload": { + "type": "string" + }, + "payloadType": { + "type": "string" + }, + "signatures": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sig": { + "type": "string" + }, + "keyid": { + "type": "string" + } + } + } + } + } + } + } + }, "hovercard": { "title": "Hovercard", "description": "Hovercard", @@ -128940,7 +139555,7 @@ }, "enterprise-webhooks": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"\n", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -129108,7 +139723,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -129881,7 +140497,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -130034,125 +140650,6 @@ "updated_at" ] }, - "simple-user-webhooks": { - "title": "Simple User", - "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, "webhooks_rule": { "title": "branch protection rule", "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", @@ -130213,6 +140710,19 @@ "everyone" ] }, + "lock_branch_enforcement_level": { + "description": "The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone.", + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "lock_allows_fork_sync": { + "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.", + "type": "boolean" + }, "merge_queue_enforcement_level": { "type": "string", "enum": [ @@ -130308,6 +140818,7 @@ "strict_required_status_checks_policy", "signature_requirement_enforcement_level", "linear_history_requirement_enforcement_level", + "lock_branch_enforcement_level", "admin_enforced", "allow_force_pushes_enforcement_level", "allow_deletions_enforcement_level", @@ -130318,6 +140829,250 @@ "authorized_actor_names" ] }, + "exemption-request-push-ruleset-bypass": { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + "exemption-request-secret-scanning": { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] + }, + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "locations": { + "type": "array", + "description": "The location data of the secret that was detected", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "string", + "description": "The commit SHA where the secret was detected" + }, + "branch": { + "type": "string", + "description": "The branch where the secret was detected" + }, + "path": { + "type": "string", + "description": "The path of the file where the secret was detected" + } + } + } + } + } + } + } + } + }, + "exemption-request-secret-scanning-metadata": { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "The label for the secret type" + }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + "exemption-response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption response." + }, + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { + "type": "string", + "description": "The login of the user who reviewed the exemption request." + }, + "status": { + "type": "string", + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] + }, + "reviewer_comment": { + "type": "string", + "description": "The comment the reviewer provided when responding to the exemption request.", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "exemption-request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." + }, + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." + }, + "requester_login": { + "type": "string", + "description": "The login of the user who requested the exemption." + }, + "request_type": { + "type": "string", + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] + }, + "exemption_request_data": { + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + }, + { + "$ref": "#/components/schemas/exemption-request-secret-scanning" + } + ] + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "status": { + "type": "string", + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] + }, + "requester_comment": { + "type": "string", + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true + }, + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + } + ] + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the exemption request was created." + }, + "responses": { + "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/exemption-response" + } + }, + "html_url": { + "type": "string", + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" + } + } + }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", @@ -130598,6 +141353,9 @@ }, "verified": { "type": "boolean" + }, + "enabled": { + "type": "boolean" } }, "required": [ @@ -130720,6 +141478,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -130908,7 +141669,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -130953,6 +141715,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131099,7 +141864,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131144,6 +141910,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131265,6 +142034,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131488,7 +142260,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131533,12 +142306,21 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ "login", "id" ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } } }, "required": [ @@ -131702,7 +142484,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131747,6 +142530,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132033,7 +142819,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -132079,6 +142866,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132222,6 +143012,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132317,6 +143110,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132531,6 +143327,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132791,6 +143590,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133151,6 +143953,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -133220,7 +144042,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -133266,6 +144089,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133401,6 +144227,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133579,6 +144408,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133673,6 +144505,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133886,6 +144721,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134144,6 +144982,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134503,6 +145344,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -134572,7 +145433,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -134617,6 +145479,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134735,6 +145600,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135113,7 +145981,7 @@ "merge-group": { "type": "object", "title": "Merge Group", - "description": "A group of pull requests that the merge queue has grouped together to be merged.\n", + "description": "A group of pull requests that the merge queue has grouped together to be merged.", "properties": { "head_sha": { "description": "The SHA of the merge group.", @@ -135151,7 +146019,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -135924,7 +146793,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -136180,6 +147049,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136316,7 +147188,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -136361,6 +147234,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136514,6 +147390,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -136539,6 +147423,8 @@ "repository_count", "repositories", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -136656,6 +147542,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136803,6 +147692,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137071,6 +147963,118 @@ "archived_at" ] }, + "projects-v2-single-select-option": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "name" + ] + }, + "projects-v2-iteration-setting": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "duration": { + "type": "number", + "nullable": true + }, + "start_date": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "title" + ] + }, + "projects-v2-status-update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "project_node_id": { + "type": "string" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z" + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28" + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + }, "webhooks_number": { "description": "The pull request number.", "type": "integer" @@ -137132,7 +148136,7 @@ ] }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**", "type": "boolean", "default": false } @@ -137363,6 +148367,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137582,6 +148589,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137810,7 +148820,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -138012,6 +149023,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138295,7 +149309,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -138340,6 +149355,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138601,7 +149619,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -138803,6 +149822,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139086,7 +150108,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -139131,6 +150154,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139315,6 +150341,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139426,6 +150455,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139953,7 +150985,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -139999,6 +151032,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140319,7 +151355,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -140364,6 +151401,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140526,7 +151566,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -140571,6 +151612,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140853,6 +151897,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141278,6 +152325,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -141621,6 +152671,10 @@ "type": "string", "description": "The type of secret that secret scanning detected." }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -141643,6 +152697,35 @@ "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true } } }, @@ -141666,6 +152749,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -141864,6 +152950,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -141958,6 +153047,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142050,6 +153142,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142342,7 +153437,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142374,7 +153469,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142409,7 +153504,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142445,7 +153540,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142535,6 +153630,62 @@ "from" ] }, + "lock_branch_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "lock_allows_fork_sync": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "pull_request_reviews_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "require_last_push_approval": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, "required_status_checks": { "type": "object", "properties": { @@ -142583,7 +153734,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142593,6 +153744,189 @@ "sender" ] }, + "webhook-exemption-request-cancelled": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-completed": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-created": { + "title": "Exemption request created event", + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-response-dismissed": { + "title": "Exemption response dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_dismissed" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, + "webhook-exemption-request-response-submitted": { + "title": "Exemption response submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_submitted" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, "webhook-check-run-completed": { "title": "Check Run Completed Event", "type": "object", @@ -142616,7 +153950,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142662,7 +153996,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142718,7 +154052,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142765,7 +154099,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142895,6 +154229,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -142987,6 +154326,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143558,7 +154900,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143676,6 +155018,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "Client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -143768,6 +155115,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144337,7 +155687,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -144450,6 +155800,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The Client ID for the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -144542,6 +155897,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145110,7 +156468,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145230,6 +156588,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145426,7 +156787,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145547,6 +156908,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145768,7 +157132,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145959,6 +157323,7 @@ "state": { "description": "State of a code scanning alert.", "type": "string", + "nullable": true, "enum": [ "open", "dismissed" @@ -146028,7 +157393,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146150,6 +157515,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146374,7 +157742,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146628,7 +157996,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146847,7 +158215,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146871,7 +158239,7 @@ ] }, "comment": { - "description": "The [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment) resource.", + "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource.", "type": "object", "properties": { "author_association": { @@ -147023,7 +158391,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -147068,6 +158437,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147105,7 +158477,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147155,7 +158527,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147179,7 +158551,7 @@ ] }, "definition": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -147191,13 +158563,12 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", - "definition", - "organization" + "definition" ] }, "webhook-custom-property-deleted": { @@ -147232,13 +158603,12 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", - "definition", - "organization" + "definition" ] }, "webhook-custom-property-updated": { @@ -147252,7 +158622,7 @@ ] }, "definition": { - "$ref": "#/components/schemas/org-custom-property" + "$ref": "#/components/schemas/custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -147264,13 +158634,12 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", - "definition", - "organization" + "definition" ] }, "webhook-custom-property-values-updated": { @@ -147296,7 +158665,7 @@ "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "new_property_values": { "type": "array", @@ -147352,7 +158721,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147389,7 +158758,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147425,7 +158794,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147461,7 +158830,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147497,7 +158866,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147533,7 +158902,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147569,7 +158938,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147605,7 +158974,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147641,7 +159010,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147677,7 +159046,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147790,6 +159159,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148003,6 +159375,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148345,7 +159720,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -148440,6 +159815,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149149,6 +160527,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149248,7 +160629,7 @@ "$ref": "#/components/schemas/simple-installation" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } } }, @@ -149283,7 +160664,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -149414,6 +160795,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149629,6 +161013,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -149980,6 +161367,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -150127,227 +161517,233 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "workflow_id": { - "type": "integer" - }, - "workflow_url": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_branch", - "head_sha", - "run_number", - "event", - "status", - "conclusion", - "workflow_id", - "check_suite_id", - "check_suite_node_id", - "url", - "html_url", - "path", - "pull_requests", - "created_at", - "updated_at", - "actor", - "triggering_actor", - "run_attempt", - "run_started_at", - "display_title" - ] - } - }, - "required": [ - "action", - "workflow_run", - "since", - "repository", - "organization", - "sender" - ] - }, - "webhook-deployment-review-rejected": { - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "rejected" - ] - }, - "approver": { - "$ref": "#/components/schemas/webhooks_approver" - }, - "comment": { - "type": "string" - }, - "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" - }, - "reviewers": { - "$ref": "#/components/schemas/webhooks_reviewers" - }, - "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" - }, - "since": { - "type": "string" - }, - "workflow_job_run": { - "$ref": "#/components/schemas/webhooks_workflow_job_run" - }, - "workflow_job_runs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conclusion": { - "type": "string", - "nullable": true - }, - "created_at": { - "type": "string" - }, - "environment": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string", - "nullable": true - }, - "status": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "workflow_run": { - "title": "Deployment Workflow Run", - "type": "object", - "nullable": true, - "properties": { - "actor": { - "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": { + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "workflow_run", + "since", + "repository", + "organization", + "sender" + ] + }, + "webhook-deployment-review-rejected": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "rejected" + ] + }, + "approver": { + "$ref": "#/components/schemas/webhooks_approver" + }, + "comment": { + "type": "string" + }, + "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" + }, + "reviewers": { + "$ref": "#/components/schemas/webhooks_reviewers" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "since": { + "type": "string" + }, + "workflow_job_run": { + "$ref": "#/components/schemas/webhooks_workflow_job_run" + }, + "workflow_job_runs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conclusion": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "environment": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": "object", + "nullable": true, + "properties": { + "actor": { + "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" + }, + "user_view_type": { "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": [ @@ -150560,6 +161956,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -150911,6 +162310,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -151057,6 +162459,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151235,6 +162640,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151252,7 +162660,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -151387,6 +162795,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151599,6 +163010,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -151950,6 +163364,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -152097,6 +163514,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152351,6 +163771,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152565,6 +163988,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152986,6 +164412,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153198,6 +164627,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153526,7 +164958,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -153621,6 +165053,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154331,6 +165766,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154417,7 +165855,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154517,7 +165955,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154554,7 +165992,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154593,7 +166031,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154633,7 +166071,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154692,7 +166130,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154730,7 +166168,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154766,7 +166204,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154829,7 +166267,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154868,7 +166306,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154905,7 +166343,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154941,7 +166379,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154977,7 +166415,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155028,7 +166466,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155062,7 +166500,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155101,7 +166539,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155138,7 +166576,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155174,7 +166612,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155287,11 +166725,6 @@ } ] }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -155390,7 +166823,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -155575,6 +167009,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156108,7 +167545,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156128,7 +167565,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156199,7 +167636,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156237,7 +167674,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156275,7 +167712,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156313,7 +167750,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156381,7 +167818,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156460,7 +167897,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156502,7 +167939,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156625,6 +168062,9 @@ }, "website_url": { "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156680,7 +168120,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "target_type": { "type": "string" @@ -156723,7 +168163,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156887,7 +168327,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -156932,6 +168373,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157066,6 +168510,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157161,6 +168608,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157375,6 +168825,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157635,6 +169088,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157996,6 +169452,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -158065,7 +169541,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -158111,6 +169588,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158236,6 +169716,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158426,7 +169909,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -158477,7 +169961,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -158612,6 +170096,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158707,6 +170194,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158921,6 +170411,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159179,6 +170672,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159538,6 +171034,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -159607,7 +171123,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -159653,6 +171170,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159778,6 +171298,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159968,7 +171491,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -159999,6 +171523,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -160019,7 +171546,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160157,6 +171684,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160252,6 +171782,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160466,6 +171999,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160726,6 +172262,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161086,6 +172625,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -161155,7 +172714,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -161201,6 +172761,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161326,6 +172889,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161516,7 +173082,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -161567,7 +173134,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -161609,7 +173176,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -161741,6 +173308,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161836,6 +173406,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162050,6 +173623,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162311,6 +173887,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162671,6 +174250,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -162740,7 +174339,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -162786,6 +174386,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162974,7 +174577,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -163005,6 +174609,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -163023,7 +174630,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163150,6 +174757,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163457,6 +175067,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163716,6 +175329,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164075,6 +175691,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -164144,7 +175780,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -164189,6 +175826,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164228,7 +175868,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164711,6 +176351,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -164962,6 +176605,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -165307,6 +176953,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -165380,7 +177046,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -165426,6 +177093,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -165441,7 +177111,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165599,6 +177269,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165908,6 +177581,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166169,6 +177845,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166529,6 +178208,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -166598,7 +178297,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -166644,6 +178344,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166686,7 +178389,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166815,6 +178518,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167124,6 +178830,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167384,6 +179093,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167744,6 +179456,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -167813,7 +179545,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -167859,6 +179592,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167901,7 +179637,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168056,6 +179792,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -168150,6 +179889,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -168385,6 +180127,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -168638,6 +180383,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -168982,6 +180730,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -169055,7 +180823,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -169100,6 +180869,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -169112,7 +180884,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169593,6 +181365,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -169845,6 +181620,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -170190,6 +181968,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -170263,7 +182061,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -170308,6 +182107,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -170323,7 +182125,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170449,6 +182251,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170543,6 +182348,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170756,6 +182564,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171014,6 +182825,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171373,6 +183187,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -171442,7 +183276,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -171487,6 +183322,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171718,7 +183556,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -171903,6 +183742,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172233,6 +184075,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172327,6 +184172,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172541,6 +184389,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172802,6 +184653,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173162,6 +185016,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -173231,7 +185105,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -173276,6 +185151,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173315,7 +185193,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173351,7 +185229,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173834,6 +185712,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -174087,6 +185968,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -174433,6 +186317,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -174506,7 +186410,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -174552,6 +186457,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -174564,7 +186472,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174688,6 +186596,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174782,6 +186693,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174995,6 +186909,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175253,6 +187170,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175612,6 +187532,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -175681,7 +187621,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -175726,6 +187667,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175958,7 +187902,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -176143,6 +188088,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176383,7 +188331,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -176424,7 +188372,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -176463,7 +188411,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -176618,6 +188566,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -176712,6 +188663,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -176947,6 +188901,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -177198,6 +189155,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -177542,6 +189502,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -177615,7 +189595,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -177660,6 +189641,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -177672,7 +189656,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -177708,7 +189692,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -177744,7 +189728,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -177779,7 +189763,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -177857,7 +189841,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -177899,7 +189883,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178050,7 +190034,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178200,7 +190184,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178350,7 +190334,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178392,7 +190376,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178462,7 +190446,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178529,7 +190513,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178566,7 +190550,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178693,6 +190677,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178831,6 +190818,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178873,7 +190863,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178912,7 +190902,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179069,7 +191059,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179104,7 +191094,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179140,7 +191130,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179176,7 +191166,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179254,7 +191244,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179291,7 +191281,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179327,7 +191317,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179363,7 +191353,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179399,7 +191389,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179434,7 +191424,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179573,6 +191563,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179618,7 +191611,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -179657,7 +191650,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179706,7 +191699,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179897,6 +191890,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179996,6 +191992,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180432,6 +192431,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180581,7 +192583,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -180721,6 +192723,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180819,6 +192824,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181029,6 +193037,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181184,7 +193195,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181309,6 +193320,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181354,7 +193368,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181377,11 +193391,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -181408,11 +193425,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -181439,11 +193459,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -181453,8 +193476,7 @@ "action", "personal_access_token_request", "organization", - "sender", - "installation" + "sender" ] }, "webhook-personal-access-token-request-denied": { @@ -181473,8 +193495,11 @@ "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -181592,7 +193617,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "zen": { "description": "Random string of GitHub zen.", @@ -181658,7 +193683,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181694,7 +193719,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181836,6 +193861,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181885,7 +193913,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181940,7 +193968,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182103,6 +194131,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182257,7 +194288,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182292,7 +194323,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182327,7 +194358,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182361,7 +194392,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182411,7 +194442,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182446,7 +194477,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182481,7 +194512,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182516,7 +194547,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182580,7 +194611,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182614,7 +194645,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182643,7 +194674,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182673,7 +194704,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182703,7 +194734,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182786,7 +194817,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182820,7 +194851,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182868,7 +194899,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182899,7 +194930,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182929,7 +194960,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182950,6 +194981,7 @@ ] }, "changes": { + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.", "oneOf": [ { "type": "object", @@ -182962,6 +194994,46 @@ }, "field_type": { "type": "string" + }, + "field_name": { + "type": "string" + }, + "project_number": { + "type": "integer" + }, + "from": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] + }, + "to": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] } } } @@ -183003,7 +195075,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -183051,7 +195123,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -183085,7 +195157,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -183116,7 +195188,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -183126,6 +195198,171 @@ "sender" ] }, + "webhook-projects-v2-status-update-created": { + "title": "Projects v2 Status Update Created Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, + "webhook-projects-v2-status-update-deleted": { + "title": "Projects v2 Status Update Deleted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, + "webhook-projects-v2-status-update-edited": { + "title": "Projects v2 Status Update Edited Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + }, + "status": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "to": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + } + } + }, + "start_date": { + "type": "object", + "properties": { + "from": { + "type": "string", + "format": "date", + "nullable": true + }, + "to": { + "type": "string", + "format": "date", + "nullable": true + } + } + }, + "target_date": { + "type": "object", + "properties": { + "from": { + "type": "string", + "format": "date", + "nullable": true + }, + "to": { + "type": "string", + "format": "date", + "nullable": true + } + } + } + } + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, "webhook-public": { "title": "public event", "type": "object", @@ -183143,7 +195380,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -183399,6 +195636,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183494,6 +195734,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183618,6 +195861,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183846,7 +196092,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -184048,6 +196295,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184187,7 +196437,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -184331,7 +196581,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184376,6 +196627,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184639,7 +196893,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -184841,6 +197096,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184980,7 +197238,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -185124,7 +197382,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -185169,6 +197428,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185352,6 +197614,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185463,6 +197728,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185645,6 +197913,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186000,7 +198271,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -186046,6 +198318,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186097,7 +198372,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -186353,6 +198628,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186571,6 +198849,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186799,7 +199080,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -187001,6 +199283,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187140,7 +199425,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -187284,7 +199569,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187329,6 +199615,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187590,7 +199879,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -187792,6 +200082,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187931,7 +200224,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -188075,7 +200368,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -188120,6 +200414,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188303,6 +200600,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188413,6 +200713,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188595,6 +200898,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188950,7 +201256,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -188996,6 +201303,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189050,7 +201360,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -189306,6 +201616,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189524,6 +201837,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189752,7 +202068,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -189954,6 +202271,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190093,7 +202413,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -190237,7 +202557,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -190282,6 +202603,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190745,6 +203069,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190884,7 +203211,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -191028,7 +203355,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -191073,6 +203401,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191256,6 +203587,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191367,6 +203701,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191549,6 +203886,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191904,7 +204244,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -191950,6 +204291,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192004,7 +204348,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -192044,7 +204388,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -192084,7 +204428,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -192124,7 +204468,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -192378,6 +204722,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192596,6 +204943,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192824,7 +205174,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -193026,6 +205377,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193165,7 +205519,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -193309,7 +205663,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193354,6 +205709,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193615,7 +205973,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -193817,6 +206176,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193956,7 +206318,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -194100,7 +206462,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -194145,6 +206508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194328,6 +206694,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194439,6 +206808,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194620,6 +206992,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194966,7 +207341,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -195012,6 +207388,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195060,13 +207439,27 @@ ] }, "reason": { - "type": "string" + "type": "string", + "enum": [ + "UNKNOWN_REMOVAL_REASON", + "MANUAL", + "MERGE", + "MERGE_CONFLICT", + "CI_FAILURE", + "CI_TIMEOUT", + "ALREADY_MERGED", + "QUEUE_CLEARED", + "ROLL_BACK", + "BRANCH_PROTECTIONS", + "GIT_TREE_INVALID", + "INVALID_MERGE_COMMIT" + ] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -195168,7 +207561,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -195423,6 +207816,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195641,6 +208037,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195869,7 +208268,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -196071,6 +208471,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196210,7 +208613,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -196354,7 +208757,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196399,6 +208803,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196660,7 +209067,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -196862,6 +209270,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197001,7 +209412,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -197145,7 +209556,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -197190,6 +209602,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197373,6 +209788,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197484,6 +209902,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197665,6 +210086,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198011,7 +210435,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -198057,6 +210482,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198108,7 +210536,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -198367,6 +210795,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198586,6 +211017,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198814,7 +211248,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -199016,6 +211451,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199155,7 +211593,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -199299,7 +211737,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199344,6 +211783,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199607,7 +212049,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -199809,6 +212252,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199948,7 +212394,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -200092,7 +212538,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -200137,6 +212584,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200321,6 +212771,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200432,6 +212885,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200614,6 +213070,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200969,7 +213428,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -201015,6 +213475,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201066,7 +213529,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -201321,6 +213784,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201540,6 +214006,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201768,7 +214237,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -201970,6 +214440,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202109,7 +214582,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -202253,7 +214726,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202298,6 +214772,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202561,7 +215038,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -202763,6 +215241,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202902,7 +215383,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -203046,7 +215527,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -203091,6 +215573,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203275,6 +215760,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203385,6 +215873,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203567,6 +216058,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203922,7 +216416,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -203968,6 +216463,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204019,7 +216517,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -204059,7 +216557,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -204098,7 +216596,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -204138,7 +216636,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -204178,7 +216676,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -204473,7 +216971,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -204518,6 +217017,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204782,6 +217284,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205001,6 +217506,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205229,7 +217737,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -205431,6 +217940,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205570,7 +218082,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -205714,7 +218226,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -205759,6 +218272,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206006,7 +218522,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -206208,6 +218725,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206347,7 +218867,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -206490,7 +219010,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -206535,6 +219056,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206721,6 +219245,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206898,6 +219425,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207247,7 +219777,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -207293,6 +219824,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207342,7 +219876,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -207593,6 +220127,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207811,6 +220348,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208039,7 +220579,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -208241,6 +220782,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208380,7 +220924,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -208524,7 +221068,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -208569,6 +221114,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208816,7 +221364,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -209018,6 +221567,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209157,7 +221709,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -209301,7 +221853,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -209346,6 +221899,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209531,6 +222087,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209707,6 +222266,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210047,7 +222609,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -210093,6 +222656,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210142,7 +222708,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -210396,6 +222962,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210490,6 +223059,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210614,6 +223186,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210842,7 +223417,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -211044,6 +223620,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211183,7 +223762,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -211327,7 +223906,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -211372,6 +223952,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211619,7 +224202,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -211821,6 +224405,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211960,7 +224547,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -212104,7 +224691,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -212149,6 +224737,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212335,6 +224926,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212511,6 +225105,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212851,7 +225448,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -212894,6 +225492,9 @@ "Mannequin" ] }, + "user_view_type": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -212946,7 +225547,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -213197,6 +225798,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213416,6 +226020,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213644,7 +226251,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -213846,6 +226454,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213985,7 +226596,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -214129,7 +226740,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214174,6 +226786,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214421,7 +227036,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -214623,6 +227239,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214762,7 +227381,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -214906,7 +227525,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214951,6 +227571,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215136,6 +227759,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215313,6 +227939,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215662,7 +228291,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -215708,6 +228338,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215888,7 +228521,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -215934,6 +228568,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215957,7 +228594,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -216224,6 +228861,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216443,6 +229083,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216666,7 +229309,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -216851,6 +229495,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217107,7 +229754,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217152,6 +229800,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217394,7 +230045,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -217579,6 +230231,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217835,7 +230490,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217880,6 +230536,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218066,6 +230725,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218243,6 +230905,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218592,7 +231257,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -218638,6 +231304,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218692,7 +231361,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -218951,6 +231620,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219045,6 +231717,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219169,6 +231844,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219397,7 +232075,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -219599,6 +232278,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219738,7 +232420,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -219882,7 +232564,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -219927,6 +232610,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220188,7 +232874,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -220390,6 +233077,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220529,7 +233219,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -220673,7 +233363,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220718,6 +233409,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220901,6 +233595,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221011,6 +233708,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221192,6 +233892,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221556,7 +234259,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -221601,6 +234305,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221736,6 +234443,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221744,7 +234454,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -222000,6 +234710,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222094,6 +234807,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222218,6 +234934,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222446,7 +235165,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -222648,6 +235368,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222787,7 +235510,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -222931,7 +235654,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222976,6 +235700,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223237,7 +235964,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -223439,6 +236167,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223578,7 +236309,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -223722,7 +236453,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -223767,6 +236499,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223950,6 +236685,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224060,6 +236798,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224241,6 +236982,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224605,7 +237349,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -224650,6 +237395,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224839,7 +237587,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -225101,6 +237849,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225196,6 +237947,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225320,6 +238074,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225548,7 +238305,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -225750,6 +238508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225889,7 +238650,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -226033,7 +238794,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226078,6 +238840,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226339,7 +239104,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -226541,6 +239307,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226680,7 +239449,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -226824,7 +239593,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226869,6 +239639,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227052,6 +239825,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227163,6 +239939,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227344,6 +240123,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227699,7 +240481,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -227745,6 +240528,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227881,6 +240667,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227889,7 +240678,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -228146,6 +240935,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228241,6 +241033,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228365,6 +241160,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228593,7 +241391,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -228795,6 +241594,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228934,7 +241736,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -229078,7 +241880,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -229123,6 +241926,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229384,7 +242190,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -229586,6 +242393,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229725,7 +242535,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -229869,7 +242679,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -229914,6 +242725,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230097,6 +242911,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230208,6 +243025,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230389,6 +243209,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230735,7 +243558,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -230781,6 +243605,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230961,7 +243788,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -231214,6 +244041,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231433,6 +244263,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231661,7 +244494,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -231863,6 +244697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232002,7 +244839,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -232146,7 +244983,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -232191,6 +245029,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232439,7 +245280,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -232641,6 +245483,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232780,7 +245625,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -232924,7 +245769,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -232969,6 +245815,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233155,6 +246004,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233332,6 +246184,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233681,7 +246536,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -233727,6 +246583,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233781,7 +246640,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -234030,6 +246889,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234248,6 +247110,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234476,7 +247341,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -234661,6 +247527,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234922,7 +247791,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -234967,6 +247837,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235215,7 +248088,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -235400,6 +248274,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235661,7 +248538,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -235706,6 +248584,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235891,6 +248772,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236068,6 +248952,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236417,7 +249304,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -236463,6 +249351,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236514,7 +249405,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -236795,7 +249686,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -236841,6 +249733,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237133,6 +250028,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237350,6 +250248,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237578,7 +250479,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -237763,6 +250665,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238024,7 +250929,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -238069,6 +250975,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238315,7 +251224,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -238500,6 +251410,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238761,7 +251674,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -238806,6 +251720,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238991,6 +251908,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239167,6 +252087,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239507,7 +252430,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -239552,6 +252476,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239603,7 +252530,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -239883,7 +252810,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -239928,6 +252856,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240233,6 +253164,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240452,6 +253386,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240680,7 +253617,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -240882,6 +253820,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -241021,7 +253962,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -241165,7 +254106,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -241210,6 +254152,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -241471,7 +254416,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -241673,6 +254619,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -241812,7 +254761,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -241956,7 +254905,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -242001,6 +254951,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242184,6 +255137,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242295,6 +255251,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242477,6 +255436,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242832,7 +255794,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -242878,6 +255841,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242929,7 +255895,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -243190,6 +256156,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243409,6 +256378,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243638,7 +256610,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -243840,6 +256813,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243979,7 +256955,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -244123,7 +257099,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -244168,6 +257145,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244431,7 +257411,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -244633,6 +257614,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244772,7 +257756,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -244916,7 +257900,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -244961,6 +257946,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245145,6 +258133,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245256,6 +258247,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245438,6 +258432,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245793,7 +258790,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -245839,6 +258837,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245890,7 +258891,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -246148,6 +259149,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -246367,6 +259371,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -246595,7 +259602,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -246797,6 +259805,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -246936,7 +259947,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -247080,7 +260091,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -247125,6 +260137,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -247388,7 +260403,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -247590,6 +260606,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -247729,7 +260748,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -247873,7 +260892,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -247918,6 +260938,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -248101,6 +261124,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -248212,6 +261238,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -248394,6 +261423,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -248749,7 +261781,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -248795,6 +261828,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -248846,7 +261882,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -249101,6 +262137,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -249318,6 +262357,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -249546,7 +262588,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -249748,6 +262791,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -249887,7 +262933,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -250031,7 +263077,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -250076,6 +263123,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -250338,7 +263388,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -250540,6 +263591,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -250679,7 +263733,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -250823,7 +263877,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -250868,6 +263923,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251051,6 +264109,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251161,6 +264222,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251342,6 +264406,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251688,7 +264755,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -251733,6 +264801,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251784,7 +264855,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -252300,7 +265371,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -252485,6 +265557,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -252704,7 +265779,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -252822,6 +265897,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -252908,6 +265986,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -253367,6 +266448,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -253486,7 +266570,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -253593,6 +266677,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -253678,6 +266765,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -253861,6 +266951,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -254001,7 +267094,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254036,7 +267129,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254072,7 +267165,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254149,7 +267242,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254459,6 +267552,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -254586,7 +267682,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254621,7 +267717,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254656,7 +267752,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254691,7 +267787,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254726,7 +267822,7 @@ "$ref": "#/components/schemas/repository-advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254761,7 +267857,7 @@ "$ref": "#/components/schemas/repository-advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254793,7 +267889,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254825,7 +267921,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254857,7 +267953,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254896,7 +267992,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -254983,7 +268079,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255010,7 +268106,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "status": { "type": "string", @@ -255050,7 +268146,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255082,7 +268178,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255141,7 +268237,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255177,7 +268273,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255212,7 +268308,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255396,7 +268492,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255533,7 +268629,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -255578,6 +268675,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -255610,7 +268710,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255643,7 +268743,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255678,7 +268778,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255827,6 +268927,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -255884,7 +268987,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -255920,7 +269023,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256120,7 +269223,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256156,7 +269259,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256191,7 +269294,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256214,6 +269317,41 @@ "payload" ] }, + "webhook-secret-scanning-alert-publicly-leaked": { + "title": "secret_scanning_alert publicly leaked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "publicly_leaked" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "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" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-reopened": { "title": "secret_scanning_alert reopened event", "type": "object", @@ -256240,7 +269378,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256275,7 +269413,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256284,14 +269422,14 @@ "repository" ] }, - "webhook-secret-scanning-alert-revoked": { - "title": "secret_scanning_alert revoked event", + "webhook-secret-scanning-alert-validated": { + "title": "secret_scanning_alert validated event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "revoked" + "validated" ] }, "alert": { @@ -256310,7 +269448,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256319,18 +269457,71 @@ "repository" ] }, - "webhook-secret-scanning-alert-validated": { - "title": "secret_scanning_alert validated event", + "webhook-secret-scanning-scan-completed": { + "title": "secret_scanning_scan completed event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "validated" + "completed" ] }, - "alert": { - "$ref": "#/components/schemas/secret-scanning-alert-webhook" + "type": { + "type": "string", + "description": "What type of scan was completed", + "enum": [ + "backfill", + "custom-pattern-backfill", + "pattern-version-backfill" + ] + }, + "source": { + "type": "string", + "description": "What type of content was scanned", + "enum": [ + "git", + "issues", + "pull-requests", + "discussions", + "wiki" + ] + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "secret_types": { + "type": "array", + "description": "List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates", + "items": { + "type": "string" + }, + "nullable": true + }, + "custom_pattern_name": { + "type": "string", + "description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated", + "nullable": true + }, + "custom_pattern_scope": { + "type": "string", + "description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated", + "enum": [ + "repository", + "organization", + "enterprise" + ], + "nullable": true + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" @@ -256341,17 +269532,16 @@ "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", - "alert", - "repository" + "source", + "type", + "started_at", + "completed_at" ] }, "webhook-security-advisory-published": { @@ -256380,7 +269570,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256414,7 +269604,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256464,6 +269654,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -256600,7 +269793,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256638,7 +269831,7 @@ "$ref": "#/components/schemas/full-repository" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -256669,7 +269862,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -256704,7 +269897,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -256756,7 +269949,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -256795,7 +269988,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -256836,7 +270029,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -256875,7 +270068,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -256911,7 +270104,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -256949,7 +270142,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -257263,6 +270456,10 @@ }, "verified": { "type": "boolean" + }, + "verified_at": { + "type": "string", + "nullable": true } }, "required": [ @@ -257453,7 +270650,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sha": { "description": "The Commit SHA.", @@ -257494,6 +270691,202 @@ "sender" ] }, + "webhook-sub-issues-parent-issue-added": { + "title": "parent issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "parent_issue_added" + ] + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "parent_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "parent_issue_id", + "parent_issue", + "parent_issue_repo", + "sub_issue_id", + "sub_issue" + ] + }, + "webhook-sub-issues-parent-issue-removed": { + "title": "parent issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "parent_issue_removed" + ] + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "parent_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "parent_issue_id", + "parent_issue", + "parent_issue_repo", + "sub_issue_id", + "sub_issue" + ] + }, + "webhook-sub-issues-sub-issue-added": { + "title": "sub-issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "sub_issue_added" + ] + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "sub_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "sub_issue_id", + "sub_issue", + "sub_issue_repo", + "parent_issue_id", + "parent_issue" + ] + }, + "webhook-sub-issues-sub-issue-removed": { + "title": "sub-issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "sub_issue_removed" + ] + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "sub_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "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" + } + }, + "required": [ + "action", + "sub_issue_id", + "sub_issue", + "sub_issue_repo", + "parent_issue_id", + "parent_issue" + ] + }, "webhook-team-add": { "title": "team_add event", "type": "object", @@ -257511,7 +270904,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -257737,7 +271130,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -257922,6 +271316,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -258136,7 +271533,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -258362,7 +271759,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -258547,6 +271945,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -258761,7 +272162,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -258988,7 +272389,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -259173,6 +272575,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -259387,7 +272792,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -259700,7 +273105,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -259885,6 +273291,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -260099,7 +273508,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -260327,7 +273736,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -260512,6 +273922,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -260726,7 +274139,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -260762,7 +274175,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -260796,7 +274209,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "type": "string" @@ -260833,7 +274246,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -261164,7 +274577,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -261527,7 +274940,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -261735,7 +275148,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -261944,7 +275357,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -262077,6 +275490,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -262109,7 +275525,8 @@ "skipped", "stale", "success", - "timed_out" + "timed_out", + "startup_failure" ] }, "created_at": { @@ -262477,6 +275894,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -262955,6 +276375,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -263118,6 +276541,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -263175,7 +276601,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -264401,7 +277827,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -264495,6 +277921,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -264849,6 +278278,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -265326,6 +278758,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -265537,6 +278972,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -265697,12 +279135,28 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], "credits": [ { "user": { @@ -265778,6 +279232,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", @@ -265815,6 +279279,7 @@ "value": { "id": 1, "slug": "octoapp", + "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", @@ -265922,7 +279387,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, @@ -265935,7 +279401,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": null } ] }, @@ -265953,6 +279420,7 @@ "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -268539,6 +282007,9 @@ }, "packages_stats": { "$ref": "server-statistics-packages.yaml" + }, + "advisory_db_stats": { + "$ref": "server-statistics-advisory-db.yaml" } } }, @@ -268651,6 +282122,8 @@ "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "allows_public_repositories": false, "restricted_to_workflows": true, "selected_workflows": [ @@ -268667,6 +282140,8 @@ "default": false, "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "hosted_runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "allows_public_repositories": true, "restricted_to_workflows": false, "selected_workflows": [ @@ -268935,6 +282410,48 @@ } ] }, + "audit-log-stream-key": { + "value": { + "key_id": "123", + "key": "actual-public-key-value" + } + }, + "get-audit-log-stream-configs": { + "value": [ + { + "id": 1, + "stream_type": "Splunk", + "stream_details": "US", + "enabled": true, + "created_at": "2024-06-06T08:00:00Z", + "updated_at": "2024-06-06T08:00:00Z", + "paused_at": null + } + ] + }, + "audit-log-stream-config-request": { + "value": { + "enabled": false, + "stream_type": "Azure Event Hubs", + "vendor_specific": { + "namespace": "newnamespace", + "shared_access_key_name": "newaccesskeyname", + "shared_access_key": "newaccesskey", + "event_hub_name": "neweventhub" + } + } + }, + "get-audit-log-stream-config": { + "value": { + "id": 1, + "stream_type": "Splunk", + "stream_details": "US", + "enabled": true, + "created_at": "2024-06-06T08:00:00Z", + "updated_at": "2024-06-06T08:00:00Z", + "paused_at": null + } + }, "code-scanning-organization-alert-items": { "value": [ { @@ -269186,6 +282703,277 @@ } ] }, + "enterprise-code-security-configuration-list": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + }, + "enterprise-code-security-configuration": { + "value": { + "id": 1325, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "code-security-default-configurations": { + "value": [ + { + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + } + } + ] + }, + "code-security-configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "simple-repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + }, "enterprise-security-analysis-settings": { "value": { "advanced_security_enabled_for_new_repositories": true, @@ -269193,6 +282981,7 @@ "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md", + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": true, "secret_scanning_validity_checks_enabled": true } }, @@ -269264,6 +283053,238 @@ ] } }, + "copilot-seats-list": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "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", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + }, + "copilot-usage-metrics-for-day": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + }, "copilot-usage-metrics-enterprise": { "value": [ { @@ -269395,6 +283416,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -269595,6 +283626,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -269740,6 +283781,90 @@ ] } }, + "custom-properties": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "custom-property": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + }, + "enterprise-ruleset": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" + } + }, "organization-secret-scanning-alert-list": { "value": [ { @@ -269863,8 +283988,33 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", - "validity": "active" + "validity": "active", + "publicly_leaked": false, + "multi_repo": false }, { "number": 1, @@ -269949,8 +284099,14 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } ] }, @@ -270003,6 +284159,22 @@ ] } }, + "get-all-cost-centers": { + "value": { + "costCenters": [ + { + "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", + "name": "Cost Center Name", + "resources": [ + { + "type": "User", + "name": "Monalisa" + } + ] + } + ] + } + }, "packages-billing-usage": { "value": { "total_gigabytes_bandwidth_used": 50, @@ -270017,6 +284189,109 @@ "estimated_storage_for_month": 40 } }, + "billing-usage-report": { + "value": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] + } + }, + "copilot-usage-metrics-org": { + "value": [ + { + "day": "2023-10-15", + "total_suggestions_count": 1000, + "total_acceptances_count": 800, + "total_lines_suggested": 1800, + "total_lines_accepted": 1200, + "total_active_users": 10, + "total_chat_acceptances": 32, + "total_chat_turns": 200, + "total_active_chat_users": 4, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 250, + "lines_suggested": 900, + "lines_accepted": 700, + "active_users": 5 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 400, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 400, + "acceptances_count": 350, + "lines_suggested": 500, + "lines_accepted": 200, + "active_users": 3 + } + ] + }, + { + "day": "2023-10-16", + "total_suggestions_count": 800, + "total_acceptances_count": 600, + "total_lines_suggested": 1100, + "total_lines_accepted": 700, + "total_active_users": 12, + "total_chat_acceptances": 57, + "total_chat_turns": 426, + "total_active_chat_users": 8, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 600, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 150, + "lines_suggested": 300, + "lines_accepted": 250, + "active_users": 6 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 200, + "acceptances_count": 150, + "lines_suggested": 200, + "lines_accepted": 150, + "active_users": 3 + } + ] + } + ] + }, "public-events-items": { "value": [ { @@ -270201,7 +284476,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -270209,6 +284485,7 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, + "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { @@ -271279,9 +285556,15 @@ "actions": [ "192.0.2.1" ], + "actions_macos": [ + "192.0.2.1" + ], "dependabot": [ "192.0.2.1" ], + "copilot": [ + "192.0.2.1" + ], "domains": { "website": [ "*.example.com" @@ -271657,6 +285940,7 @@ "web_commit_signoff_required": false, "updated_at": "2014-03-03T18:58:10Z", "archived_at": null, + "deploy_keys_enabled_for_repositories": false, "dependency_graph_enabled_for_new_repositories": false, "dependabot_alerts_enabled_for_new_repositories": false, "dependabot_security_updates_enabled_for_new_repositories": false, @@ -271886,6 +286170,8 @@ "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, @@ -271903,6 +286189,8 @@ "default": false, "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", "inherited": false, "allows_public_repositories": true, "restricted_to_workflows": true, @@ -272316,6 +286604,134 @@ "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } }, + "list-attestations": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + }, "simple-user-items": { "value": [ { @@ -272340,6 +286756,195 @@ } ] }, + "push-rule-bypass-request-items": { + "value": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "push_ruleset_bypass", + "data": [ + { + "ruleset_id": 410, + "ruleset_name": "Exclude image files", + "total_violations": 1, + "rule_type": "file_extension_restriction" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Updating site images to follow changes in marketing. Part 1", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" + }, + { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "push_ruleset_bypass", + "data": [ + { + "ruleset_id": 410, + "ruleset_name": "Exclude image files", + "total_violations": 1, + "rule_type": "file_extension_restriction" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Updating site images to follow changes in marketing. Part 2", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" + } + ] + }, + "code-security-configuration-list": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 17, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + }, + "code-security-configuration-updated": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, "codespaces-list": { "value": { "total_count": 3, @@ -272820,169 +287425,13 @@ "inactive_this_cycle": 11 }, "seat_management_setting": "assign_selected", - "public_code_suggestions": "block" + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" } }, - "copilot-seats-list": { - "value": { - "total_seats": 2, - "seats": [ - { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "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", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } - } - ] - } - }, - "copilot-usage-metrics-org": { - "value": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ] - }, "credential-authorization-items": { "value": [ { @@ -273422,6 +287871,86 @@ "type": "Organization" } }, + "api-insights-route-stats": { + "value": [ + { + "http_method": "GET", + "api_route": "/repositories/:repository_id", + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, + "api-insights-subject-stats": { + "value": [ + { + "subject_type": "installation", + "subject_id": 954453, + "subject_name": "GitHub Actions", + "integration_id": 124345, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, + "api-insights-summary-stats": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + }, + "api-insights-time-stats": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 + }, + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 + }, + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 + }, + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + }, + "api-insights-user-stats": { + "value": [ + { + "actor_type": "oauth_app", + "actor_id": 954453, + "actor_name": "GitHub Actions", + "oauth_application_id": 1245, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, "installation": { "value": { "id": 1, @@ -273450,6 +287979,7 @@ "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, + "client_id": "Iv1.ab1112223334445c", "target_id": 1, "target_type": "Organization", "permissions": { @@ -273747,6 +288277,7 @@ "pending_cancellation_date": null, "last_activity_at": "2021-10-14T00:53:32-06:00", "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", "assignee": { "login": "octocat", "id": 1, @@ -274658,6 +289189,8 @@ } }, "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -274699,12 +289232,59 @@ } }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null } ] }, + "org-private-registry-configurations-paginated": { + "value": { + "total_count": 1, + "configurations": [ + { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected" + } + ] + } + }, + "org-private-registry-configuration": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "org-private-registry-configuration-with-selected-repositories": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ], + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "private-registries-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, "project-items": { "value": [ { @@ -274781,44 +289361,6 @@ "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" - ], - "values_editable_by": "org_actors" - }, - { - "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": [ { @@ -275479,7 +290021,7 @@ { "id": 21, "actor_id": 12, - "username": "octocat", + "actor_name": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", @@ -275491,7 +290033,7 @@ { "id": 25, "actor_id": 11, - "username": "not-octocat", + "actor_name": "not-octocat", "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", "ref": "refs/heads/i-am-everything", @@ -275507,7 +290049,7 @@ "value": { "id": 21, "actor_id": 12, - "username": "octocat", + "actor_name": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", @@ -275644,6 +290186,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", "score": 9.8 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-123", @@ -275821,6 +290373,16 @@ "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", "score": 1.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 7.1 + } + }, "cwes": [ { "cwe_id": "CWE-456", @@ -276895,6 +291457,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -277141,6 +291709,7 @@ "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, + "allow_forking": true, "subscribers_count": 42, "network_count": 0, "license": { @@ -277423,6 +291992,9 @@ "secret_scanning_push_protection": { "status": "disabled" }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + }, "secret_scanning_validity_checks": { "status": "disabled" } @@ -278568,6 +293140,68 @@ } ] }, + "attestation": { + "value": { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\n— rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + } + } + }, "autolink-items": { "value": [ { @@ -278636,7 +293270,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", @@ -279256,7 +293891,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null }, "comment_count": 0 }, @@ -279331,6 +293967,52 @@ "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" } }, + "push-rule-bypass-request-item": { + "value": { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "push_ruleset_bypass", + "data": [ + { + "ruleset_id": 410, + "ruleset_name": "Exclude image files", + "total_violations": 1, + "rule_type": "file_extension_restriction" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Updating site images to follow changes in marketing. Part 2", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" + } + }, "check-run-example-of-completed-conclusion": { "summary": "Response for completed conclusion", "value": { @@ -280532,6 +295214,39 @@ "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" } }, + "code-scanning-autofix": { + "value": { + "status": "success", + "description": "This fixes an XSS vulnerability by escaping the user input.", + "started_at": "2024-02-14T12:29:18Z" + } + }, + "code-scanning-bad-request": { + "value": { + "message": "The alert_number is not valid", + "documentation_url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert", + "status": "400" + } + }, + "code-scanning-autofix-pending": { + "value": { + "status": "pending", + "description": null, + "started_at": "2024-02-14T12:29:18Z" + } + }, + "code-scanning-autofix-commits": { + "value": { + "target_ref": "refs/heads/fix-bug", + "message": "Let's fix this 🪲!" + } + }, + "code-scanning-autofix-commits-response": { + "value": { + "target_ref": "refs/heads/main", + "sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" + } + }, "code-scanning-alert-instances": { "value": [ { @@ -280807,6 +295522,264 @@ "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" } }, + "code-scanning-variant-analysis": { + "summary": "Default response", + "value": { + "id": 1, + "controller_repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "query_language": "python", + "query_pack_url": "https://www.example.com", + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "completed_at": "2022-09-12T13:15:33Z", + "status": "completed", + "actions_workflow_run_id": 3453588, + "scanned_repositories": [ + { + "repository": { + "id": 1296269, + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "private": false + }, + "analysis_status": "succeeded", + "result_count": 532, + "artifact_size_in_bytes": 12345 + } + ], + "skipped_repositories": { + "access_mismatch_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo1", + "full_name": "octo-org/octo-repo1", + "private": false + }, + { + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo2", + "full_name": "octo-org/octo-repo2", + "private": false + } + ] + }, + "not_found_repos": { + "repository_count": 3, + "repository_full_names": [ + "octo-org/octo-repo4", + "octo-org/octo-repo5", + "octo-org/octo-repo6" + ] + }, + "no_codeql_db_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 7, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo7", + "full_name": "octo-org/octo-repo7", + "private": false + }, + { + "id": 8, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo8", + "full_name": "octo-org/octo-repo8", + "private": false + } + ] + }, + "over_limit_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 9, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo9", + "full_name": "octo-org/octo-repo9", + "private": false + }, + { + "id": 10, + "node_id": "MDQ6VXNlcjE=", + "name": "octo-repo10", + "full_name": "octo-org/octo-repo10", + "private": false + } + ] + } + } + } + }, + "code-scanning-variant-analysis-repo-task": { + "summary": "Default response", + "value": { + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "analysis_status": "succeeded", + "artifact_size_in_bytes": 12345, + "result_count": 532, + "database_commit_sha": "2d870c2a717a524627af38fa2da382188a096f90", + "source_location_prefix": "/", + "artifact_url": "https://example.com" + } + }, "code-scanning-default-setup": { "value": { "state": "configured", @@ -280844,6 +295817,37 @@ "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" } }, + "code-security-configuration-for-repository": { + "value": { + "status": "attached", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + }, "codeowners-errors": { "value": { "errors": [ @@ -281555,7 +296559,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -282171,7 +297176,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -282644,7 +297650,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -282722,7 +297729,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -282805,7 +297813,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } }, "author": { @@ -283072,7 +298081,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } } @@ -283126,7 +298136,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } } @@ -283165,7 +298176,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } } @@ -283242,6 +298254,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -283375,6 +298397,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -283486,6 +298518,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -283585,6 +298627,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -283744,19 +298796,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseDeclared": "MIT", + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -284466,7 +299549,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } @@ -284503,7 +299587,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } }, @@ -284564,7 +299649,8 @@ "verified": false, "reason": "unsigned", "signature": null, - "payload": null + "payload": null, + "verified_at": null } } }, @@ -286115,7 +301201,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } ] }, @@ -286129,7 +301216,8 @@ "created_at": "2014-12-10T15:53:42Z", "read_only": true, "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" + "last_used": "2022-01-10T15:53:42Z", + "enabled": true } }, "label": { @@ -286286,6 +301374,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -289159,8 +304249,33 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", - "validity": "inactive" + "validity": "inactive", + "publicly_leaked": false, + "multi_repo": false }, { "number": 1, @@ -289178,8 +304293,14 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } ] }, @@ -289200,8 +304321,14 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } }, "secret-scanning-alert-resolved": { @@ -289240,8 +304367,14 @@ "push_protection_bypassed": false, "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", - "validity": "unknown" + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false } }, "secret-scanning-location-list": { @@ -289313,7 +304446,7 @@ { "type": "pull_request_title", "details": { - "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, { @@ -289342,6 +304475,70 @@ } ] }, + "secret-scanning-push-protection-bypass": { + "value": { + "reason": "will_fix_later", + "expire_at": "2020-11-06T18:18:30Z", + "token_type": "mailchimp_api_key" + } + }, + "secret-scanning-scan-history": { + "value": { + "incremental_scans": [ + { + "type": "git", + "status": "completed", + "completed_at": "2024-10-07T02:47:00Z" + } + ], + "backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:50:00Z" + }, + { + "type": "issue", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:49:00Z" + }, + { + "type": "discussion", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:48:00Z" + } + ], + "pattern_update_scans": [ + { + "type": "discussion", + "status": "in_progress", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:51:00Z" + } + ], + "custom_pattern_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z", + "pattern_slug": "my-custom-pattern", + "pattern_scope": "enterprise" + }, + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z", + "pattern_slug": "my-custom-pattern", + "pattern_scope": "organization" + } + ] + } + }, "repository-advisory": { "value": { "ghsa_id": "GHSA-abcd-1234-efgh", @@ -289436,6 +304633,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", "score": 9.8 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-123", @@ -289648,6 +304855,10 @@ } ], "cvss": null, + "cvss_severities": { + "cvss_v3": null, + "cvss_v4": null + }, "cwes": [ { "cwe_id": "CWE-123", @@ -290634,7 +305845,7 @@ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "id": "927fa2c08dcb4a7fae9e", + "id": "24b28bbb-5fc4-4686-a153-a020debb1155", "displayName": "Engineering", "members": [ { @@ -290652,7 +305863,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } ], @@ -290684,7 +305895,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } }, @@ -296013,7 +311224,9 @@ "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false }, "location": { "type": "commit", @@ -296410,6 +311623,15 @@ ] } }, + "audit-log-stream-id": { + "name": "stream_id", + "description": "The ID of the audit log stream configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "tool-name": { "name": "tool_name", "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", @@ -296428,6 +311650,15 @@ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" } }, + "configuration-id": { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -296508,6 +311739,15 @@ "maximum": 100 } }, + "custom-property-name": { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "secret-scanning-alert-state": { "name": "state", "in": "query", @@ -296524,7 +311764,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -296562,6 +311802,89 @@ "type": "string" } }, + "secret-scanning-alert-publicly-leaked": { + "name": "is_publicly_leaked", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-multi-repo": { + "name": "is_multi_repo", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "cost-center": { + "name": "cost_center_id", + "description": "The ID corresponding to the cost center.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "billing-usage-report-year": { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-month": { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-day": { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-hour": { + "name": "hour", + "description": "If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "enterprise-team-slug": { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "team-slug": { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "enterprise-security-product": { "name": "security_product", "in": "path", @@ -296574,7 +311897,8 @@ "advanced_security_user_namespace", "dependabot_alerts", "secret_scanning", - "secret_scanning_push_protection" + "secret_scanning_push_protection", + "secret_scanning_non_provider_patterns" ] } }, @@ -296606,7 +311930,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "labels": { @@ -296788,6 +312113,66 @@ "type": "string" } }, + "repository-name-in-query": { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + "bypass-reviewer-name": { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "bypass-requester-name": { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "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" + } + }, + "bypass-request-status": { + "name": "request_status", + "description": "The status of the bypass request to filter on. When specified, only requests with this status will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, "role-id": { "name": "role_id", "description": "The unique identifier of the role.", @@ -296806,6 +312191,24 @@ "type": "integer" } }, + "members-per-page": { + "name": "per_page", + "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + "members-page": { + "name": "page", + "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, "hook-id": { "name": "hook_id", "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", @@ -296815,6 +312218,135 @@ "type": "integer" } }, + "api-insights-actor-type": { + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, + "schema": { + "type": "string", + "enum": [ + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] + } + }, + "api-insights-actor-id": { + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + }, + "api-insights-min-timestamp": { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-max-timestamp": { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-route-stats-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "http_method", + "api_route", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + "api-insights-api-route-substring": { + "name": "api_route_substring", + "in": "query", + "description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + "api-insights-subject-name-substring": { + "name": "subject_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-user-id": { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-timestamp-increment": { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-actor-name-substring": { + "name": "actor_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, "invitation-id": { "name": "invitation_id", "description": "The unique identifier of the invitation.", @@ -296851,15 +312383,6 @@ "type": "string" } }, - "team-slug": { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, "package-visibility": { "name": "visibility", "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", @@ -296985,38 +312508,24 @@ "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.", + "ruleset-targets": { + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "example": "branch,tag,push" } }, - "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).", + "ref-in-query": { + "name": "ref", + "description": "The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", "in": "query", - "required": false, "schema": { - "type": "string", - "enum": [ - "hour", - "day", - "week", - "month" - ], - "default": "day" - } + "type": "string" + }, + "x-multi-segment": true }, "actor-name-in-query": { "name": "actor_name", @@ -297423,6 +312932,15 @@ "$ref": "#/components/schemas/code-scanning-ref" } }, + "pr-alias": { + "name": "pr", + "description": "The number of the pull request for the results you want to list.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, "alert-number": { "name": "alert_number", "in": "path", @@ -297613,15 +313131,6 @@ "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.", @@ -297993,6 +313502,19 @@ } } }, + "conflict": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "no_content": { + "description": "A header with no content is returned." + }, "internal_error": { "description": "Internal Error", "content": { @@ -298003,6 +313525,90 @@ } } }, + "usage_metrics_api_disabled": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "get_all_cost_centers": { + "description": "Response when getting cost centers", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-all-cost-centers" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-all-cost-centers" + } + } + } + } + }, + "add_resource_to_cost_center": { + "description": "Response when adding resources to a cost center", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Resources successfully added to the cost center." + } + } + } + } + } + }, + "remove_resource_from_cost_center": { + "description": "Response when removing resources from a cost center", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Resources successfully removed from the cost center." + } + } + } + } + } + }, + "billing_usage_report": { + "description": "Response when getting a billing usage report", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-usage-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-usage-report" + } + } + } + } + }, "forbidden_gist": { "description": "Forbidden Gist", "content": { @@ -298046,12 +313652,17 @@ } } }, - "conflict": { - "description": "Conflict", + "billing_usage_report_org": { + "description": "Billing usage report response for an organization", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/basic-error" + "$ref": "#/components/schemas/billing-usage-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-usage-report" + } } } } @@ -298059,9 +313670,6 @@ "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, - "no_content": { - "description": "A header with no content is returned." - }, "gone": { "description": "Gone", "content": { @@ -298102,6 +313710,31 @@ } } }, + "code_scanning_bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-bad-request" + } + } + } + } + }, + "code_scanning_autofix_create_forbidden": { + "description": "Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "found": { "description": "Found" }, diff --git a/cache/ghes-3.12.json b/cache/ghes-3.12.json index 702f0923d..054dfb7df 100644 --- a/cache/ghes-3.12.json +++ b/cache/ghes-3.12.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.6.0", + "version": "17.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": { @@ -148,6 +148,14 @@ { "name": "enterprise-admin", "description": "Enterprise Administration" + }, + { + "name": "oauth-authorizations", + "description": "OAuth Authorizations API" + }, + { + "name": "security-advisories", + "description": "Manage security advisories." } ], "servers": [ @@ -1941,7 +1949,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/authorization-items" + "$ref": "#/components/examples/classic-personal-access-tokens" } } } @@ -2429,6 +2437,22 @@ "type": "string" } }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/pagination-before" }, @@ -2458,7 +2482,9 @@ "type": "string", "enum": [ "updated", - "published" + "published", + "epss_percentage", + "epss_percentile" ], "default": "published" } @@ -2800,14 +2826,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -3839,7 +3857,7 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.12/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.12/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], @@ -4006,7 +4024,7 @@ "/applications/grants": { "get": { "summary": "List your grants", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.12/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.12/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", "tags": [ "oauth-authorizations" ], @@ -4084,7 +4102,7 @@ "/applications/grants/{grant_id}": { "get": { "summary": "Get a single grant", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", "tags": [ "oauth-authorizations" ], @@ -4137,7 +4155,7 @@ }, "delete": { "summary": "Delete a grant", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "tags": [ "oauth-authorizations" ], @@ -4180,7 +4198,7 @@ "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", - "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" @@ -4240,7 +4258,7 @@ "/applications/{client_id}/token": { "post": { "summary": "Check a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -4313,7 +4331,7 @@ }, "patch": { "summary": "Reset a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -4383,7 +4401,7 @@ }, "delete": { "summary": "Delete an app token", - "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.", + "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], @@ -4443,7 +4461,7 @@ "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", - "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], @@ -4562,7 +4580,7 @@ "/apps/{app_slug}": { "get": { "summary": "Get an app", - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", + "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "tags": [ "apps" ], @@ -4611,7 +4629,7 @@ "/authorizations": { "get": { "summary": "List your authorizations", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", "tags": [ "oauth-authorizations" ], @@ -4687,7 +4705,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.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/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.12/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.12/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.12/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.12/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.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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.12/rest/authentication/authenticating-to-the-rest-api#using-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.12/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.12/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.12/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" ], @@ -4813,7 +4831,7 @@ "/authorizations/clients/{client_id}": { "put": { "summary": "Get-or-create an authorization for a specific app", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], @@ -4910,7 +4928,7 @@ } }, "201": { - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", "content": { "application/json": { "schema": { @@ -4960,7 +4978,7 @@ "/authorizations/clients/{client_id}/{fingerprint}": { "put": { "summary": "Get-or-create an authorization for a specific app and fingerprint", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], @@ -5102,7 +5120,7 @@ "/authorizations/{authorization_id}": { "get": { "summary": "Get a single authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", "tags": [ "oauth-authorizations" ], @@ -5155,7 +5173,7 @@ }, "patch": { "summary": "Update an existing authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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\nIf 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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\nIf 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", "tags": [ "oauth-authorizations" ], @@ -5267,7 +5285,7 @@ }, "delete": { "summary": "Delete an authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/).", "tags": [ "oauth-authorizations" ], @@ -7685,7 +7703,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "actions", "subcategory": "self-hosted-runners" @@ -8700,7 +8718,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -8758,7 +8776,7 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], @@ -8858,7 +8876,7 @@ }, "post": { "summary": "Create a gist", - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "description": "Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", "operationId": "gists/create", "tags": [ "gists" @@ -10256,7 +10274,7 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -10532,7 +10550,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-ssh-keys" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys" }, "servers": [ { @@ -10589,7 +10607,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#set-ssh-key" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key" }, "servers": [ { @@ -10666,7 +10684,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#delete-ssh-key" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#delete-a-ssh-key" }, "servers": [ { @@ -10745,7 +10763,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-system-requirements-check-results-on-configured-nodes" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-the-system-requirement-check-results-for-configured-cluster-nodes" }, "servers": [ { @@ -10794,17 +10812,76 @@ "x-octokit": {} } }, + "/manage/v1/cluster/status": { + "get": { + "summary": "Get the status of services running on all cluster nodes", + "description": "Gets the status of all services running on each cluster node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-cluster-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-cluster-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-cluster-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-cluster-status" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, "/manage/v1/config/apply": { "get": { "summary": "Get the status of a ghe-config-apply run", "description": "Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID.", - "operationId": "enterprise-admin/get-manage-settings", + "operationId": "enterprise-admin/get-manage-config-apply-status", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-config-apply-status" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run" }, "parameters": [ { @@ -10911,13 +10988,13 @@ "post": { "summary": "Trigger a ghe-config-apply run", "description": "Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.", - "operationId": "enterprise-admin/get-manage-settings", + "operationId": "enterprise-admin/post-manage-run-config-apply", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#run-config-apply" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run" }, "requestBody": { "required": false, @@ -11001,13 +11078,13 @@ "get": { "summary": "List events from ghe-config-apply", "description": "Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance.", - "operationId": "enterprise-admin/get-manage-settings", + "operationId": "enterprise-admin/get-manage-config-apply-events", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-config-apply-events" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#list-events-from-ghe-config-apply" }, "parameters": [ { @@ -11150,15 +11227,15 @@ }, "/manage/v1/config/init": { "post": { - "summary": "Initialize instance configuration with license upload", - "description": "When you boot a GitHub instance for the first time, you can use this endpoint to upload a license.\n\nNote that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process.\n\nThis endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/initialize-instance-configuration", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-upload" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" }, "servers": [ { @@ -11186,7 +11263,7 @@ "default": { "value": { "license": "@enterprise.ghl", - "password": "secret-password!" + "password": "provide-password-here!" } } } @@ -11276,7 +11353,7 @@ }, "put": { "summary": "Upload an enterprise license", - "description": "Uploads an enterprise license. This operation does not automatically activate the license.", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/license-upload", "tags": [ "enterprise-admin" @@ -11300,11 +11377,6 @@ } } ], - "parameters": [ - { - "$ref": "#/components/parameters/license-apply" - } - ], "requestBody": { "required": true, "content": { @@ -11316,7 +11388,7 @@ }, "examples": { "default": { - "value": "@license.ghl" + "value": "@enterprise.ghl" } } } @@ -11495,7 +11567,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-settings" + "url": "https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-the-ghes-settings" }, "servers": [ { @@ -12117,7 +12189,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -12651,7 +12723,7 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], @@ -12710,15 +12782,15 @@ }, "/organizations/{organization_id}/custom_roles": { "get": { - "summary": "Deprecated - List custom repository roles in an organization", - "description": "**Note**: This operation is deprecated and will be removed in the future.\nUse the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Closing down - List custom repository roles in an organization", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#deprecated---list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -12776,7 +12848,7 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.12/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.12/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], @@ -12820,7 +12892,7 @@ }, "patch": { "summary": "Update an organization", - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], @@ -12907,7 +12979,7 @@ }, "members_allowed_repository_creation_type": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", "private", @@ -12935,27 +13007,27 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -13818,7 +13890,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13939,7 +14011,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13985,7 +14057,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14084,7 +14156,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14116,7 +14188,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14183,7 +14255,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14248,7 +14320,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14285,7 +14357,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14320,7 +14392,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14392,7 +14464,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14457,7 +14529,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14494,7 +14566,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -14529,7 +14601,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -17486,7 +17558,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -17553,6 +17625,12 @@ }, { "$ref": "#/components/parameters/group-id" + }, + { + "$ref": "#/components/parameters/members-per-page" + }, + { + "$ref": "#/components/parameters/members-page" } ], "responses": { @@ -17654,7 +17732,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -18008,7 +18086,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -18191,14 +18269,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -18486,7 +18556,7 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -18825,7 +18895,7 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.12/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.12/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], @@ -19601,7 +19671,7 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19694,7 +19764,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19741,7 +19811,7 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19787,7 +19857,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19842,7 +19912,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19933,7 +20003,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -19983,7 +20053,7 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -20032,7 +20102,7 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -21310,7 +21380,7 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], @@ -21529,7 +21599,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -21539,7 +21609,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -21556,7 +21626,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -21706,6 +21776,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -21776,7 +21849,8 @@ "enum": [ "branch", "tag" - ] + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -21797,6 +21871,14 @@ "items": { "$ref": "#/components/schemas/repository-rule" } + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] } }, "required": [ @@ -21895,6 +21977,9 @@ { "$ref": "#/components/parameters/org" }, + { + "$ref": "#/components/parameters/ref-in-query" + }, { "$ref": "#/components/parameters/repository-name-in-query" }, @@ -22001,7 +22086,7 @@ "/orgs/{org}/rulesets/{ruleset_id}": { "get": { "summary": "Get an organization repository ruleset", - "description": "Get a repository ruleset for an organization.", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], @@ -22626,7 +22711,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push" @@ -22695,7 +22780,7 @@ "/orgs/{org}/teams/{team_slug}": { "get": { "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -22742,7 +22827,7 @@ }, "patch": { "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -22792,7 +22877,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -22871,7 +22956,7 @@ }, "delete": { "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], @@ -22905,7 +22990,7 @@ "/orgs/{org}/teams/{team_slug}/discussions": { "get": { "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -22975,7 +23060,7 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23059,7 +23144,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23106,7 +23191,7 @@ }, "patch": { "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23180,7 +23265,7 @@ }, "delete": { "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23217,7 +23302,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23281,7 +23366,7 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23357,7 +23442,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23407,7 +23492,7 @@ }, "patch": { "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23483,7 +23568,7 @@ }, "delete": { "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -23523,7 +23608,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -23606,7 +23691,7 @@ }, "post": { "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -23709,7 +23794,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -23752,7 +23837,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -23832,7 +23917,7 @@ }, "post": { "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -23932,7 +24017,7 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -24196,7 +24281,7 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#create-a-team).", "tags": [ "teams" ], @@ -24246,7 +24331,7 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], @@ -24328,7 +24413,7 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], @@ -24368,7 +24453,7 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "tags": [ "teams" ], @@ -24428,7 +24513,7 @@ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -24478,7 +24563,7 @@ }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -24569,7 +24654,7 @@ }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], @@ -24606,7 +24691,7 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], @@ -24666,7 +24751,7 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], @@ -24722,7 +24807,7 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.12/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.12/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], @@ -24754,8 +24839,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "default": "push" + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." } } }, @@ -24785,7 +24869,7 @@ }, "delete": { "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], @@ -24825,7 +24909,7 @@ "/orgs/{org}/teams/{team_slug}/teams": { "get": { "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], @@ -24885,7 +24969,7 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], @@ -26488,7 +26572,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.12/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.12/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.12/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.12/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.12/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.12/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.12/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.12/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.12/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.12/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.12/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.12/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.12/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.12/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -26544,7 +26628,7 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], @@ -26735,7 +26819,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -26745,7 +26829,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -26762,7 +26846,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -26844,12 +26928,12 @@ { "required": false, "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.12/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.12/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" }, { "required": false, "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.12/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -28962,7 +29046,7 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], @@ -29511,7 +29595,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], @@ -30946,7 +31030,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs for a workflow", - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], @@ -31531,7 +31615,7 @@ ], "responses": { "200": { - "description": "Response if dependabot is enabled", + "description": "Response if Dependabot is enabled", "content": { "application/json": { "schema": { @@ -31549,7 +31633,7 @@ } }, "404": { - "description": "Not Found if dependabot is not enabled for the repository" + "description": "Not Found if Dependabot is not enabled for the repository" } }, "x-github": { @@ -31582,7 +31666,7 @@ }, { "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "description": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", "required": false, "schema": { @@ -31741,7 +31825,7 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], @@ -31780,7 +31864,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -32278,7 +32362,7 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], @@ -32483,7 +32567,7 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.12/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.12/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], @@ -32707,7 +32791,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -33188,7 +33272,7 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], @@ -33349,32 +33433,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -33443,32 +33523,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -33537,31 +33613,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -34024,32 +34097,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -34119,32 +34188,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -34214,31 +34279,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -34289,7 +34351,7 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], @@ -34691,7 +34753,7 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}": { "get": { "summary": "Get a check run", - "description": "Gets a single check run using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -34738,7 +34800,7 @@ }, "patch": { "summary": "Update a check run", - "description": "Updates a check run for a specific commit in a 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -35186,7 +35248,7 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.12/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.12/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], @@ -35365,7 +35427,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { "get": { "summary": "Get a check suite", - "description": "Gets a single check suite using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -35414,7 +35476,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "Lists check runs for a check suite using its `id`.\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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -35910,7 +35972,7 @@ "/repos/{owner}/{repo}/code-scanning/analyses": { "get": { "summary": "List code scanning analyses for a repository", - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/list-recent-analyses", "tags": [ "code-scanning" @@ -36305,7 +36367,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -36672,7 +36734,7 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.12/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.12/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", + "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.12/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.12/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", "tags": [ "repos" ], @@ -36739,7 +36801,7 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n**Note**: A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.12/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.12/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], @@ -37246,7 +37308,7 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.12/rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.12/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], @@ -37286,7 +37348,7 @@ "/repos/{owner}/{repo}/commits": { "get": { "summary": "List commits", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -37339,11 +37401,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -37526,7 +37595,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -37567,7 +37636,7 @@ }, "line": { "type": "integer", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." + "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ @@ -37697,7 +37766,7 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -37767,7 +37836,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\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.12/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.12/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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.12/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.12/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -37870,7 +37939,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], @@ -38082,7 +38151,7 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.12/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], @@ -38221,7 +38290,16 @@ { "$ref": "#/components/schemas/content-submodule" } - ] + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "array": "#/components/schemas/content-directory", + "file": "#/components/schemas/content-file", + "symlink": "#/components/schemas/content-symlink", + "submodule": "#/components/schemas/content-submodule" + } + } }, "examples": { "response-if-content-is-a-file": { @@ -38243,6 +38321,9 @@ "302": { "$ref": "#/components/responses/found" }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -38260,7 +38341,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], @@ -38423,7 +38504,21 @@ "$ref": "#/components/responses/not_found" }, "409": { - "$ref": "#/components/responses/conflict" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/basic-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } }, "422": { "$ref": "#/components/responses/validation_failed" @@ -38439,7 +38534,7 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], @@ -38695,7 +38790,7 @@ }, { "name": "page", - "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", "deprecated": true, "in": "query", "schema": { @@ -39899,7 +39994,7 @@ }, "target_url": { "type": "string", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.", "default": "" }, "log_url": { @@ -40078,7 +40173,7 @@ }, "client_payload": { "type": "object", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.", "additionalProperties": true, "maxProperties": 10 } @@ -40186,7 +40281,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}": { "get": { "summary": "Get an environment", - "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], @@ -40233,7 +40328,7 @@ }, "put": { "summary": "Create or update an environment", - "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], @@ -40871,7 +40966,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { "get": { "summary": "List custom deployment rule integrations available for an environment", - "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-server@3.12/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-server@3.12/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], @@ -41639,7 +41734,7 @@ "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", - "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -41771,7 +41866,7 @@ }, "post": { "summary": "Create a fork", - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", + "description": "Create a fork for the authenticated user.\n\n> [!NOTE]\n> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", "tags": [ "repos" ], @@ -41946,7 +42041,21 @@ "$ref": "#/components/responses/conflict" }, "422": { - "$ref": "#/components/responses/validation_failed" + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } } }, "x-github": { @@ -42027,7 +42136,7 @@ "/repos/{owner}/{repo}/git/commits": { "post": { "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -42061,7 +42170,7 @@ }, "parents": { "type": "array", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", "items": { "type": "string" } @@ -42184,7 +42293,7 @@ "/repos/{owner}/{repo}/git/commits/{commit_sha}": { "get": { "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -42239,7 +42348,7 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], @@ -42299,7 +42408,7 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], @@ -42574,7 +42683,7 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.12/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.12/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.12/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.12/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -42711,7 +42820,7 @@ "/repos/{owner}/{repo}/git/tags/{tag_sha}": { "get": { "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], @@ -42839,7 +42948,7 @@ }, "base_tree": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n" + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." } }, "required": [ @@ -42913,7 +43022,7 @@ "/repos/{owner}/{repo}/git/trees/{tree_sha}": { "get": { "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", "tags": [ "git" ], @@ -43339,7 +43448,7 @@ }, "delete": { "summary": "Delete a repository webhook", - "description": "", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", "tags": [ "repos" ], @@ -43533,14 +43642,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -43725,7 +43826,7 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { "post": { "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", "tags": [ "repos" ], @@ -43992,7 +44093,7 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -44134,7 +44235,7 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.12/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.12/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -44175,7 +44276,7 @@ }, "assignee": { "type": "string", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_", "nullable": true }, "milestone": { @@ -44740,7 +44841,7 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.12/rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.12/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], @@ -44906,7 +45007,7 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.12/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.12/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.12/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.12/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -44965,7 +45066,7 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -45012,7 +45113,7 @@ "assignee": { "type": "string", "nullable": true, - "description": "Username to assign to this issue. **This field is deprecated.**" + "description": "Username to assign to this issue. **This field is closing down.**" }, "state": { "type": "string", @@ -45432,7 +45533,7 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -46321,7 +46422,7 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.12/rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.12/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], @@ -48144,7 +48245,7 @@ "properties": { "cname": { "type": "string", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.12/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.12/pages/configuring-a-custom-domain-for-your-github-pages-site).\"", "nullable": true }, "https_enforced": { @@ -49159,7 +49260,7 @@ }, "post": { "summary": "Create a pull request", - "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-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -49720,7 +49821,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.12/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.12/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -49760,7 +49861,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get a pull request", - "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-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "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-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], @@ -49782,7 +49883,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -50003,7 +50104,7 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.12/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.12/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -50044,7 +50145,7 @@ }, "position": { "type": "integer", - "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "deprecated": true, "x-github": { "deprecationDate": "2022-11-01" @@ -50156,7 +50257,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -50309,7 +50410,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -50419,7 +50520,7 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], @@ -50872,7 +50973,7 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -51273,7 +51374,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.12/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.12/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], @@ -51462,7 +51563,7 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { "put": { "summary": "Update a pull request branch", - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.", "tags": [ "pulls" ], @@ -51594,6 +51695,9 @@ } } }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "404": { "$ref": "#/components/responses/not_found" }, @@ -51745,7 +51849,7 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], @@ -51808,7 +51912,7 @@ "false", "legacy" ], - "default": true + "default": "true" } }, "required": [ @@ -51872,7 +51976,7 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], @@ -52236,7 +52340,7 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], @@ -52500,7 +52604,7 @@ }, "servers": [ { - "url": "https://uploads.github.com", + "url": "https://HOSTNAME/api/uploads", "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], @@ -52761,7 +52865,7 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.12/rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.12/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], @@ -53023,6 +53127,9 @@ "type": "boolean", "default": true } + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -53096,7 +53203,8 @@ "enum": [ "branch", "tag" - ] + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -53317,7 +53425,7 @@ "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { "get": { "summary": "Get a repository ruleset", - "description": "Get a ruleset for a repository.", + "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], @@ -54609,15 +54717,15 @@ }, "/repos/{owner}/{repo}/tags/protection": { "get": { - "summary": "List tag protection states for a repository", - "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", + "summary": "Closing down - List tag protection states for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/list-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/repos/tags#list-tag-protection-states-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.12/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository" }, "parameters": [ { @@ -54657,20 +54765,23 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} }, "post": { - "summary": "Create a tag protection state for a repository", - "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Create a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/create-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/repos/tags#create-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.12/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -54733,22 +54844,25 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { "delete": { - "summary": "Delete a tag protection state for a repository", - "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Delete a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/delete-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.12/rest/repos/tags#delete-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.12/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -54776,15 +54890,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tarball/{ref}": { "get": { "summary": "Download a repository archive (tar)", - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", "tags": [ "repos" ], @@ -54987,7 +55104,7 @@ "properties": { "names": { "type": "array", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.", "items": { "type": "string" } @@ -55236,7 +55353,7 @@ "/repos/{owner}/{repo}/zipball/{ref}": { "get": { "summary": "Download a repository archive (zip)", - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "tags": [ "repos" ], @@ -55401,14 +55518,14 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "repos", "subcategory": "repos", "previews": [ { "required": true, "name": "baptiste", - "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -55493,7 +55610,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -55576,7 +55693,7 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" @@ -55658,7 +55775,7 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" @@ -55723,7 +55840,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" @@ -55833,7 +55950,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" @@ -55953,7 +56070,7 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nDeletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" @@ -56005,7 +56122,7 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" @@ -56084,7 +56201,7 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" @@ -56166,7 +56283,7 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" @@ -56228,7 +56345,7 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" @@ -56308,7 +56425,7 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" @@ -56446,7 +56563,7 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" @@ -56703,7 +56820,7 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.12/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.12/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.12/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.12/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], @@ -57357,7 +57474,7 @@ }, "post": { "summary": "Enable or disable maintenance mode", - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "> [!NOTE]\n> The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", "operationId": "enterprise-admin/enable-or-disable-maintenance-mode", "tags": [ "enterprise-admin" @@ -57439,7 +57556,7 @@ "/setup/api/settings": { "get": { "summary": "Get settings", - "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/management-console#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API.", + "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/management-console#set-settings).\n\n> [!NOTE]\n> You cannot retrieve the management console password with the Enterprise administration API.", "operationId": "enterprise-admin/get-settings", "tags": [ "enterprise-admin" @@ -57788,7 +57905,7 @@ "/setup/api/start": { "post": { "summary": "Create a GitHub license", - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/create-enterprise-server-license", "tags": [ "enterprise-admin" @@ -57867,7 +57984,7 @@ "/setup/api/upgrade": { "post": { "summary": "Upgrade a license", - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "This API upgrades your license and also triggers the configuration process.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/upgrade-license", "tags": [ "enterprise-admin" @@ -57934,7 +58051,7 @@ "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], @@ -57981,7 +58098,7 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], @@ -58028,7 +58145,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -58113,7 +58230,7 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], @@ -58153,7 +58270,7 @@ "/teams/{team_id}/discussions": { "get": { "summary": "List discussions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58214,7 +58331,7 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58298,7 +58415,7 @@ "/teams/{team_id}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58345,7 +58462,7 @@ }, "patch": { "summary": "Update a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58419,7 +58536,7 @@ }, "delete": { "summary": "Delete a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58456,7 +58573,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58520,7 +58637,7 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58596,7 +58713,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58646,7 +58763,7 @@ }, "patch": { "summary": "Update a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58722,7 +58839,7 @@ }, "delete": { "summary": "Delete a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], @@ -58762,7 +58879,7 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -58845,7 +58962,7 @@ }, "post": { "summary": "Create reaction for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -58933,7 +59050,7 @@ "/teams/{team_id}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -59013,7 +59130,7 @@ }, "post": { "summary": "Create reaction for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], @@ -59098,7 +59215,7 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.12/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.12/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], @@ -59176,7 +59293,7 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], @@ -59214,7 +59331,7 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], @@ -59258,7 +59375,7 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], @@ -59298,7 +59415,7 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#create-a-team).", "tags": [ "teams" ], @@ -59348,7 +59465,7 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], @@ -59433,7 +59550,7 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], @@ -59473,7 +59590,7 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "tags": [ "teams" ], @@ -59536,7 +59653,7 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "tags": [ "teams" ], @@ -59586,7 +59703,7 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", "tags": [ "teams" ], @@ -59682,7 +59799,7 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", "tags": [ "teams" ], @@ -59725,7 +59842,7 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], @@ -59788,7 +59905,7 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], @@ -59844,7 +59961,7 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], @@ -59917,7 +60034,7 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], @@ -59957,7 +60074,7 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], @@ -60049,7 +60166,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "response-with-public-and-private-profile-information": { @@ -60335,9 +60459,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 + "example": "username@example.com" }, + "minItems": 1, "example": [] } }, @@ -60447,9 +60571,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 - } + "example": "username@example.com" + }, + "minItems": 1 } }, "example": { @@ -60733,6 +60857,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -61232,7 +61359,7 @@ "/user/installations/{installation_id}/repositories/{repository_id}": { "put": { "summary": "Add a repository to an app installation", - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], @@ -61283,7 +61410,7 @@ }, "delete": { "summary": "Remove a repository from an app installation", - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], @@ -61339,7 +61466,7 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], @@ -62263,7 +62390,7 @@ "/user/orgs": { "get": { "summary": "List organizations for the authenticated user", - "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.", "tags": [ "orgs" ], @@ -62326,7 +62453,7 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62398,7 +62525,7 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62442,7 +62569,7 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62485,7 +62612,7 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62537,7 +62664,7 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62625,7 +62752,7 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62672,7 +62799,7 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -62718,7 +62845,7 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -63175,7 +63302,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -63192,7 +63319,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -64297,6 +64424,69 @@ "x-octokit": {} } }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.12/rest/users/emails)\".", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.12/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + }, + "x-octokit": {} + } + }, "/users": { "get": { "summary": "List users", @@ -64387,7 +64577,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "default-response": { @@ -64468,7 +64665,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64520,7 +64717,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64575,7 +64772,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -65133,7 +65330,7 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65214,7 +65411,7 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65261,7 +65458,7 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65307,7 +65504,7 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65362,7 +65559,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by a user", - "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65423,7 +65620,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65473,7 +65670,7 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65522,7 +65719,7 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], @@ -65646,7 +65843,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -65698,7 +65895,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -66372,6 +66569,58 @@ }, "x-octokit": {} } + }, + "/orgs/{org}/organization-fine-grained-permissions": { + "get": { + "summary": "List organization fine-grained permissions for an organization", + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-organization-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-fine-grained-permission" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-fine-grained-permission-example" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } } }, "x-webhooks": { @@ -66998,7 +67247,7 @@ }, "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { @@ -67123,7 +67372,7 @@ }, "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { @@ -67248,7 +67497,7 @@ }, "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.12/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", "operationId": "check-run/requested-action", "externalDocs": { @@ -67373,7 +67622,7 @@ }, "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.12/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", "operationId": "check-run/rerequested", "externalDocs": { @@ -67498,7 +67747,7 @@ }, "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { @@ -67607,7 +67856,7 @@ }, "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.12/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.12/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", "operationId": "check-suite/requested", "externalDocs": { @@ -67716,7 +67965,7 @@ }, "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.12/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.12/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", "operationId": "check-suite/rerequested", "externalDocs": { @@ -68696,7 +68945,7 @@ }, "delete": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", "operationId": "delete", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#delete" @@ -68804,7 +69053,7 @@ }, "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { @@ -68913,7 +69162,7 @@ }, "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", "operationId": "dependabot-alert/auto-reopened", "externalDocs": { @@ -69022,7 +69271,7 @@ }, "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", "operationId": "dependabot-alert/created", "externalDocs": { @@ -69131,7 +69380,7 @@ }, "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert was manually closed.", "operationId": "dependabot-alert/dismissed", "externalDocs": { @@ -69240,7 +69489,7 @@ }, "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A manifest file change removed a vulnerability.", "operationId": "dependabot-alert/fixed", "externalDocs": { @@ -69349,7 +69598,7 @@ }, "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", "operationId": "dependabot-alert/reintroduced", "externalDocs": { @@ -69458,7 +69707,7 @@ }, "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.12/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", "description": "A Dependabot alert was manually reopened.", "operationId": "dependabot-alert/reopened", "externalDocs": { @@ -70322,7 +70571,7 @@ }, "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.12/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.12/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.12/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.12/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", "description": "A new deployment status was created.", "operationId": "deployment-status/created", "externalDocs": { @@ -70431,7 +70680,7 @@ }, "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was marked as the answer.", "operationId": "discussion/answered", "externalDocs": { @@ -70540,7 +70789,7 @@ }, "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The category of a discussion was changed.", "operationId": "discussion/category-changed", "externalDocs": { @@ -70649,7 +70898,7 @@ }, "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was closed.", "operationId": "discussion/closed", "externalDocs": { @@ -70758,7 +71007,7 @@ }, "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was created.", "operationId": "discussion-comment/created", "externalDocs": { @@ -70867,7 +71116,7 @@ }, "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was deleted.", "operationId": "discussion-comment/deleted", "externalDocs": { @@ -70976,7 +71225,7 @@ }, "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was edited.", "operationId": "discussion-comment/edited", "externalDocs": { @@ -71085,7 +71334,7 @@ }, "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was created.", "operationId": "discussion/created", "externalDocs": { @@ -71194,7 +71443,7 @@ }, "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was deleted.", "operationId": "discussion/deleted", "externalDocs": { @@ -71303,7 +71552,7 @@ }, "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", "operationId": "discussion/edited", "externalDocs": { @@ -71412,7 +71661,7 @@ }, "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was added to a discussion.", "operationId": "discussion/labeled", "externalDocs": { @@ -71521,7 +71770,7 @@ }, "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was locked.", "operationId": "discussion/locked", "externalDocs": { @@ -71630,7 +71879,7 @@ }, "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was pinned.", "operationId": "discussion/pinned", "externalDocs": { @@ -71739,7 +71988,7 @@ }, "discussion-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was reopened.", "operationId": "discussion/reopened", "externalDocs": { @@ -71848,7 +72097,7 @@ }, "discussion-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was transferred to another repository.", "operationId": "discussion/transferred", "externalDocs": { @@ -71957,7 +72206,7 @@ }, "discussion-unanswered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was unmarked as the answer.", "operationId": "discussion/unanswered", "externalDocs": { @@ -72066,7 +72315,7 @@ }, "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was removed from a discussion.", "operationId": "discussion/unlabeled", "externalDocs": { @@ -72175,7 +72424,7 @@ }, "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unlocked.", "operationId": "discussion/unlocked", "externalDocs": { @@ -72284,7 +72533,7 @@ }, "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.12/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unpinned.", "operationId": "discussion/unpinned", "externalDocs": { @@ -78260,7 +78509,7 @@ }, "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was approved.", "operationId": "personal-access-token-request/approved", "externalDocs": { @@ -78351,7 +78600,7 @@ }, "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was cancelled by the requester.", "operationId": "personal-access-token-request/cancelled", "externalDocs": { @@ -78442,7 +78691,7 @@ }, "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was created.", "operationId": "personal-access-token-request/created", "externalDocs": { @@ -78533,7 +78782,7 @@ }, "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.12/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was denied.", "operationId": "personal-access-token-request/denied", "externalDocs": { @@ -80276,7 +80525,7 @@ }, "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was closed.", "operationId": "projects-v2/closed", "externalDocs": { @@ -80384,7 +80633,7 @@ }, "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was created.", "operationId": "projects-v2/created", "externalDocs": { @@ -80492,7 +80741,7 @@ }, "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was deleted.", "operationId": "projects-v2/deleted", "externalDocs": { @@ -80600,7 +80849,7 @@ }, "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The title, description, or README of a project in the organization was changed.", "operationId": "projects-v2/edited", "externalDocs": { @@ -80708,7 +80957,7 @@ }, "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/archived", "externalDocs": { @@ -80816,7 +81065,7 @@ }, "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A draft issue in an organization project was converted to an issue.", "operationId": "projects-v2-item/converted", "externalDocs": { @@ -80924,7 +81173,7 @@ }, "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was added to a project in the organization.", "operationId": "projects-v2-item/created", "externalDocs": { @@ -81032,7 +81281,7 @@ }, "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was deleted from a project in the organization.", "operationId": "projects-v2-item/deleted", "externalDocs": { @@ -81140,7 +81389,7 @@ }, "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", "operationId": "projects-v2-item/edited", "externalDocs": { @@ -81248,7 +81497,7 @@ }, "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", "operationId": "projects-v2-item/reordered", "externalDocs": { @@ -81356,7 +81605,7 @@ }, "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/restored", "externalDocs": { @@ -81464,7 +81713,7 @@ }, "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.12/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was reopened.", "operationId": "projects-v2/reopened", "externalDocs": { @@ -84623,7 +84872,7 @@ }, "push": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", "operationId": "push", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#push" @@ -84731,7 +84980,7 @@ }, "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.12/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.12/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package was published to a registry.", "operationId": "registry-package/published", "externalDocs": { @@ -84840,7 +85089,7 @@ }, "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.12/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.12/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.12/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package that was previously published to a registry was updated.", "operationId": "registry-package/updated", "externalDocs": { @@ -87307,7 +87556,7 @@ }, "repository-vulnerability-alert-create": { "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A repository vulnerability alert was created.", "operationId": "repository-vulnerability-alert/create", "externalDocs": { @@ -87415,7 +87664,7 @@ }, "repository-vulnerability-alert-dismiss": { "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A repository vulnerability alert was dismissed.", "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { @@ -87523,7 +87772,7 @@ }, "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { @@ -87631,7 +87880,7 @@ }, "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A repository vulnerability alert was marked as resolved.", "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { @@ -88189,13 +88438,13 @@ } } }, - "secret-scanning-alert-revoked": { + "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-server@3.12/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-server@3.12/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 global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.12/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.12/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/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-server@3.12/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-server@3.12/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -88276,7 +88525,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -88289,127 +88538,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-updated": { "post": { "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.12/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.12/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/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-server@3.12/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-server@3.12/webhooks/webhook-events-and-payloads#security_advisory" - }, - "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" - } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "security_advisory", - "supported-webhook-types": [ - "app" - ] - } - } - }, - "security-advisory-updated": { - "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.12/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.12/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.12/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-server@3.12/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#security_advisory" }, @@ -91826,7 +91966,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "key": { "type": "string" @@ -91837,7 +91978,8 @@ }, "repository_id": { "nullable": true, - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -91940,6 +92082,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -92134,6 +92277,10 @@ }, "business_plus": { "type": "boolean" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -92253,7 +92400,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -92352,7 +92500,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -92420,6 +92569,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -92497,6 +92647,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -92745,7 +92899,7 @@ }, "organization_copilot_seat_management": { "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] @@ -92798,7 +92952,7 @@ }, "organization_projects": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", @@ -92927,6 +93081,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -93004,6 +93159,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -93085,7 +93244,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -93248,6 +93408,58 @@ "vulnerable_functions" ] }, + "cvss-severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, "security-advisory-credit-types": { "type": "string", "description": "The type of credit the user is receiving.", @@ -93433,6 +93645,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "nullable": true, @@ -93455,6 +93670,18 @@ ] } }, + "epss": { + "type": "object", + "nullable": true, + "properties": { + "percentage": { + "type": "number" + }, + "percentile": { + "type": "number" + } + } + }, "credits": { "type": "array", "description": "In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available.", @@ -93641,10 +93868,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -93783,6 +94006,13 @@ "type": "integer", "example": 123, "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true } }, "required": [ @@ -93957,6 +94187,13 @@ "example": 123, "nullable": true }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + }, "url": { "description": "The URL target of the delivery.", "type": "string", @@ -94309,7 +94546,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -94710,7 +94948,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -94915,6 +95153,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "url": { @@ -95943,6 +96182,7 @@ "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", + "nullable": true, "enum": [ "open", "dismissed", @@ -95968,7 +96208,6 @@ "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "nullable": true, "enum": [ - null, "false positive", "won't fix", "used in tests" @@ -95992,14 +96231,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "nullable": true, "type": "string", @@ -96025,6 +96256,14 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -96146,6 +96385,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, @@ -96685,6 +96925,9 @@ ], "additionalProperties": false }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "description": "Details for the advisory pertaining to Common Weakness Enumeration.", @@ -96993,7 +97236,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -97348,10 +97591,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -97445,6 +97684,26 @@ "rocket" ] }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -97661,6 +97920,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -98032,6 +98294,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -98104,7 +98371,11 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" }, "node_id": { "type": "string" @@ -98184,6 +98455,11 @@ "format": "email", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -98239,11 +98515,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "private_gists": { "type": "integer", "example": 1 @@ -98544,6 +98815,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -98976,6 +99252,54 @@ } } }, + "ghes-cluster-status-indicator": { + "type": "string", + "enum": [ + "UNKNOWN", + "OK", + "WARNING", + "CRITICAL" + ] + }, + "ghes-cluster-status": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "name": { + "type": "string" + }, + "details": { + "type": "string" + } + } + } + } + } + } + } + } + }, "ghes-config-init-request": { "title": "Initialize configuration with license upload", "type": "object", @@ -99292,7 +99616,9 @@ }, "base": { "type": "array", - "items": {} + "items": { + "type": "string" + } }, "uid": { "nullable": true, @@ -99314,7 +99640,9 @@ }, "user_groups": { "type": "array", - "items": {} + "items": { + "type": "string" + } }, "admin_group": { "nullable": true, @@ -99801,15 +100129,6 @@ "192.0.2.1" ] }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -99857,6 +100176,49 @@ "example.com" ] } + }, + "actions_inbound": { + "type": "object", + "properties": { + "full_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "wildcard_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + }, + "artifact_attestations": { + "type": "object", + "properties": { + "trust_domain": { + "type": "string", + "example": [ + "example" + ] + }, + "services": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } } } }, @@ -99932,6 +100294,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -100668,7 +101031,8 @@ "collaborators": { "type": "integer", "example": 8, - "nullable": true + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", @@ -100760,27 +101124,27 @@ "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -101279,6 +101643,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -102095,6 +102460,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 79 }, "owner": { @@ -102355,6 +102721,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -102378,6 +102752,8 @@ "repositories_url", "permissions", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -102390,7 +102766,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." }, "owner": { "$ref": "#/components/schemas/simple-user" @@ -102436,6 +102812,14 @@ "type": "string", "description": "Date and time when the fine-grained personal access token was approved to access the organization." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -102458,6 +102842,8 @@ "repositories_url", "permissions", "access_granted_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -102588,7 +102974,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -102989,7 +103376,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -103176,6 +103563,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -103747,7 +104135,7 @@ }, "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.", + "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 not available for the `repository` target.", "enum": [ "disabled", "active", @@ -103781,11 +104169,12 @@ }, "bypass_mode": { "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\n", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", "enum": [ "always", "pull_request" - ] + ], + "default": "always" } } }, @@ -103873,7 +104262,7 @@ "org-ruleset-conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\n", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -104026,6 +104415,33 @@ } } }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { + "type": "string", + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", @@ -104043,6 +104459,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -104111,6 +104534,10 @@ "parameters": { "type": "object", "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, "required_status_checks": { "type": "array", "description": "Status checks that are required.", @@ -104425,6 +104852,10 @@ "parameters": { "type": "object", "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, "workflows": { "type": "array", "description": "Workflows that must pass for this rule to pass.", @@ -104566,6 +104997,7 @@ }, "html": { "type": "object", + "nullable": true, "properties": { "href": { "type": "string", @@ -104721,11 +105153,12 @@ }, "evaluation_result": { "type": "string", + "nullable": true, "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`." + "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`. Null if no rules with `evaluate` enforcement status were run." }, "rule_evaluations": { "type": "array", @@ -104775,7 +105208,8 @@ }, "details": { "type": "string", - "description": "Any associated details with the rule evaluation." + "nullable": true, + "description": "The detailed failure message for the rule. Null if the rule passed." } } } @@ -106304,7 +106738,8 @@ "id": { "description": "The project card's ID", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -106498,6 +106933,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -107043,7 +107481,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -107064,7 +107503,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -107099,7 +107539,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -107551,8 +107992,9 @@ "properties": { "id": { "description": "The id of the environment.", - "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 56780428 }, "node_id": { "type": "string", @@ -107633,8 +108075,9 @@ }, "id": { "description": "Unique identifier of the deployment", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 42 }, "node_id": { "type": "string", @@ -108120,7 +108563,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -108169,6 +108613,9 @@ }, "site_admin": { "type": "boolean" + }, + "user_view_type": { + "type": "string" } } } @@ -108318,12 +108765,19 @@ "site_admin": { "type": "boolean", "example": false + }, + "user_view_type": { + "type": "string", + "example": "public" } } }, "name": { "type": "string" }, + "client_id": { + "type": "string" + }, "description": { "type": "string" }, @@ -108730,10 +109184,26 @@ ] }, "author": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "committer": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "parents": { "type": "array", @@ -109228,7 +109698,8 @@ "id": { "description": "The id of the check.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "head_sha": { "description": "The SHA of the commit that is being checked.", @@ -109528,7 +109999,8 @@ "properties": { "id": { "type": "integer", - "example": 5 + "example": 5, + "format": "int64" }, "node_id": { "type": "string", @@ -109790,7 +110262,7 @@ }, "full_description": { "type": "string", - "description": "description of the rule used to detect the alert." + "description": "A description of the rule used to detect the alert." }, "tags": { "nullable": true, @@ -110027,6 +110499,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -110091,6 +110564,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -110245,6 +110719,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -110355,6 +110830,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -110389,6 +110868,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -110499,6 +110979,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -110708,6 +111192,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -111283,6 +111768,9 @@ "sha": { "type": "string" }, + "content": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -111319,9 +111807,6 @@ "path": { "type": "string" }, - "content": { - "type": "string" - }, "sha": { "type": "string" }, @@ -111418,9 +111903,7 @@ "sha", "size", "type", - "url", - "content", - "encoding" + "url" ] }, "content-directory": { @@ -111930,6 +112413,49 @@ } } }, + "secret-scanning-push-protection-bypass-placeholder-id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "repository-rule-violation-error": { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, "contributor": { "title": "Contributor", "description": "Contributor", @@ -112006,6 +112532,9 @@ }, "name": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -112265,6 +112794,11 @@ "example": "SPDX-2.3", "description": "The version of the SPDX specification that this document conforms to." }, + "comment": { + "type": "string", + "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/", + "description": "An optional comment about the SPDX document." + }, "creationInfo": { "type": "object", "properties": { @@ -112297,17 +112831,9 @@ "example": "CC0-1.0", "description": "The license under which the SPDX document is licensed." }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "example": "github/github" - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", - "example": "https://github.com/example/dependency_graph/sbom-123", + "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "description": "The namespace for the SPDX document." }, "packages": { @@ -112322,7 +112848,7 @@ }, "name": { "type": "string", - "example": "rubygems:github/github", + "example": "github/github", "description": "The name of the package." }, "versionInfo": { @@ -112355,6 +112881,11 @@ "example": "NOASSERTION", "description": "The distribution source of this package, or NOASSERTION if this was not determined." }, + "copyrightText": { + "type": "string", + "example": "Copyright (c) 1985 GitHub.com", + "description": "The copyright holders of the package, and any dates present with those notices, if available." + }, "externalRefs": { "type": "array", "items": { @@ -112390,8 +112921,33 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "example": "DEPENDS_ON", + "description": "The type of relationship between the two SPDX elements." + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -112401,7 +112957,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -112620,6 +113175,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -112657,7 +113213,7 @@ "example": "production" }, "target_url": { - "description": "Deprecated: the URL to associate with this status.", + "description": "Closing down notice: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", @@ -112747,7 +113303,8 @@ "id": { "description": "The id of the environment.", "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -113590,7 +114147,8 @@ "id": { "description": "Unique identifier of the repository invitation.", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "repository": { "$ref": "#/components/schemas/minimal-repository" @@ -113863,6 +114421,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -115122,6 +115683,7 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 @@ -115142,6 +115704,7 @@ "type": "string" }, "description": { + "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true @@ -115152,6 +115715,7 @@ "type": "string" }, "default": { + "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } @@ -115567,14 +116131,16 @@ }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", - "example": 42, "type": "integer", + "format": "int64", + "example": 42, "nullable": true }, "id": { "description": "The ID of the pull request review comment.", - "example": 1, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { "description": "The node ID of the pull request review comment.", @@ -115592,12 +116158,12 @@ "type": "string" }, "position": { - "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", + "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", "example": 1, "type": "integer" }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", + "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", "example": 4, "type": "integer" }, @@ -116601,6 +117167,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -116791,596 +117358,13 @@ "type": "string" }, "repo": { - "type": "object", - "nullable": true, - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "spdx_id": { - "type": "string", - "nullable": true - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -117401,567 +117385,13 @@ "type": "string" }, "repo": { - "type": "object", - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -118169,7 +117599,8 @@ "id": { "description": "Unique identifier of the review", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -118273,11 +117704,13 @@ }, "pull_request_review_id": { "type": "integer", + "format": "int64", "example": 42, "nullable": true }, "id": { "type": "integer", + "format": "int64", "example": 10 }, "node_id": { @@ -118870,7 +118303,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -119060,7 +118493,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -119075,7 +118508,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -120431,6 +119864,26 @@ } } }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "type": "string" }, @@ -121138,7 +120591,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -121256,6 +120710,9 @@ "type": "string", "format": "date-time", "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121786,8 +121243,12 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, + "user_view_type": { + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -121886,6 +121347,12 @@ "example": "octocat@github.com", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -121973,11 +121440,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "business_plus": { "type": "boolean" }, @@ -122063,6 +121525,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 3 }, "name": { @@ -122124,7 +121587,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "primary_key_id": { "type": "integer" @@ -122241,7 +121705,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -122380,7 +121845,7 @@ }, "enterprise-webhooks": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.12/admin/overview/about-enterprise-accounts).\"\n", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.12/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -122548,7 +122013,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -123316,7 +122782,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -123469,125 +122935,6 @@ "updated_at" ] }, - "simple-user-webhooks": { - "title": "Simple User", - "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, "webhooks_rule": { "title": "branch protection rule", "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", @@ -123743,6 +123090,7 @@ "strict_required_status_checks_policy", "signature_requirement_enforcement_level", "linear_history_requirement_enforcement_level", + "lock_branch_enforcement_level", "admin_enforced", "allow_force_pushes_enforcement_level", "allow_deletions_enforcement_level", @@ -124155,6 +123503,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -124343,7 +123694,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -124388,6 +123740,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124495,6 +123850,131 @@ "format": "date-time" }, "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", + "format": "int64" + }, + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "answer_chosen_at": { + "type": "string", + "nullable": true + }, + "answer_chosen_by": { "title": "User", "type": "object", "nullable": true, @@ -124579,127 +124059,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body" - ] - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "answer_chosen_at": { - "type": "string", - "nullable": true - }, - "answer_chosen_by": { - "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": { + "user_view_type": { "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": [ @@ -124923,7 +124285,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -124968,12 +124331,21 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ "login", "id" ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } } }, "required": [ @@ -125137,7 +124509,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -125182,6 +124555,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125468,7 +124844,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -125514,6 +124891,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125657,6 +125037,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125752,6 +125135,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125966,6 +125352,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126226,6 +125615,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126586,6 +125978,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -126655,7 +126067,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -126701,6 +126114,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126836,6 +126252,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127014,6 +126433,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127108,6 +126530,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127321,6 +126746,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127579,6 +127007,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127938,6 +127369,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -128007,7 +127458,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -128052,6 +127504,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128170,6 +127625,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128330,7 +127788,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -129098,7 +128557,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -129354,6 +128813,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129490,7 +128952,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -129535,6 +128998,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129688,6 +129154,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -129713,6 +129187,8 @@ "repository_count", "repositories", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -129830,6 +129306,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129977,6 +129456,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130306,7 +129788,7 @@ ] }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**", "type": "boolean", "default": false } @@ -130537,6 +130019,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130756,6 +130241,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130984,7 +130472,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -131186,6 +130675,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131469,7 +130961,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131514,6 +131007,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131775,7 +131271,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -131977,6 +131474,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132260,7 +131760,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -132305,6 +131806,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132489,6 +131993,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132600,6 +132107,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133127,7 +132637,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -133173,6 +132684,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133493,7 +133007,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -133538,6 +133053,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133700,7 +133218,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -133745,6 +133264,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134027,6 +133549,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134452,6 +133977,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -134840,6 +134368,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -135038,6 +134569,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -135132,6 +134666,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135224,6 +134761,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135516,7 +135056,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135548,7 +135088,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135583,7 +135123,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135619,7 +135159,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135709,6 +135249,34 @@ "from" ] }, + "pull_request_reviews_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "require_last_push_approval": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, "required_status_checks": { "type": "object", "properties": { @@ -135757,7 +135325,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135795,7 +135363,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135828,7 +135396,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135874,7 +135442,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135930,7 +135498,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135977,7 +135545,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136107,6 +135675,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -136199,6 +135772,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136770,7 +136346,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136888,6 +136464,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "Client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -136980,6 +136561,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137549,7 +137133,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137662,6 +137246,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The Client ID for the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -137754,6 +137343,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138322,7 +137914,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138442,6 +138034,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138638,7 +138233,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138759,6 +138354,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138980,7 +138578,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139171,6 +138769,7 @@ "state": { "description": "State of a code scanning alert.", "type": "string", + "nullable": true, "enum": [ "open", "dismissed" @@ -139240,7 +138839,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139362,6 +138961,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139586,7 +139188,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139840,7 +139442,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140059,7 +139661,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140083,7 +139685,7 @@ ] }, "comment": { - "description": "The [commit comment](https://docs.github.com/enterprise-server@3.12/rest/commits/comments#get-a-commit-comment) resource.", + "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource.", "type": "object", "properties": { "author_association": { @@ -140235,7 +139837,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -140280,6 +139883,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140317,7 +139923,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140367,7 +139973,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140411,7 +140017,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140448,7 +140054,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140484,7 +140090,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140520,7 +140126,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140556,7 +140162,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140592,7 +140198,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140628,7 +140234,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140664,7 +140270,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140700,7 +140306,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140736,7 +140342,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140849,6 +140455,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141062,6 +140671,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141404,7 +141016,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -141499,6 +141111,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142208,6 +141823,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142307,7 +141925,7 @@ "$ref": "#/components/schemas/simple-installation" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } } }, @@ -142342,7 +141960,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -142473,6 +142091,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142688,6 +142309,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -143039,6 +142663,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -143186,6 +142813,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143275,7 +142905,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -143407,6 +143037,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143619,6 +143252,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -143970,6 +143606,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -144116,6 +143755,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144294,6 +143936,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144311,7 +143956,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -144446,6 +144091,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144658,6 +144306,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -145009,6 +144660,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -145156,6 +144810,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145410,6 +145067,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145624,6 +145284,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146045,6 +145708,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146257,6 +145923,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146585,7 +146254,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -146680,6 +146349,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147390,6 +147062,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147476,7 +147151,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147576,7 +147251,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147613,7 +147288,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147652,7 +147327,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147692,7 +147367,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147751,7 +147426,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147789,7 +147464,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147825,7 +147500,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147888,7 +147563,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147927,7 +147602,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147964,7 +147639,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148000,7 +147675,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148036,7 +147711,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148087,7 +147762,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148121,7 +147796,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148160,7 +147835,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148197,7 +147872,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148233,7 +147908,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148253,7 +147928,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148270,7 +147945,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148380,11 +148055,6 @@ } ] }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -148483,7 +148153,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -148668,6 +148339,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149189,8 +148863,7 @@ } } } - ], - "properties": {} + ] }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -149202,7 +148875,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149222,7 +148895,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149293,7 +148966,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149331,7 +149004,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149369,7 +149042,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149407,7 +149080,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149475,7 +149148,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149554,7 +149227,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149596,7 +149269,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149719,6 +149392,9 @@ }, "website_url": { "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149774,7 +149450,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "target_type": { "type": "string" @@ -149817,7 +149493,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149981,7 +149657,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -150026,6 +149703,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150160,6 +149840,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150255,6 +149938,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150469,6 +150155,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150729,6 +150418,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151090,6 +150782,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -151159,7 +150871,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -151205,6 +150918,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151330,6 +151046,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151520,7 +151239,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -151571,7 +151291,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -151706,6 +151426,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151801,6 +151524,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152015,6 +151741,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152273,6 +152002,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152632,6 +152364,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -152701,7 +152453,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -152747,6 +152500,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152872,6 +152628,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153062,7 +152821,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -153093,6 +152853,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -153113,7 +152876,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -153251,6 +153014,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153346,6 +153112,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153560,6 +153329,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153820,6 +153592,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154180,6 +153955,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -154249,7 +154044,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -154295,6 +154091,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154420,6 +154219,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154610,7 +154412,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -154661,7 +154464,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154703,7 +154506,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154835,6 +154638,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154930,6 +154736,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155144,6 +154953,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155405,6 +155217,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155765,6 +155580,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -155834,7 +155669,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -155880,6 +155716,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156068,7 +155907,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -156099,6 +155939,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -156117,7 +155960,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156244,6 +156087,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156551,6 +156397,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156810,6 +156659,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157169,6 +157021,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -157238,7 +157110,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -157283,6 +157156,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157322,7 +157198,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -157805,6 +157681,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -158056,6 +157935,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -158401,6 +158283,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -158474,7 +158376,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -158520,6 +158423,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -158535,7 +158441,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -158693,6 +158599,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159002,6 +158911,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159263,6 +159175,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159623,6 +159538,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -159692,7 +159627,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -159738,6 +159674,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159780,7 +159719,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -159909,6 +159848,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160218,6 +160160,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160478,6 +160423,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160838,6 +160786,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -160907,7 +160875,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -160953,6 +160922,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160995,7 +160967,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -161150,6 +161122,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -161244,6 +161219,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -161479,6 +161457,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -161732,6 +161713,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -162076,6 +162060,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -162149,7 +162153,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -162194,6 +162199,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -162206,7 +162214,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162687,6 +162695,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -162939,6 +162950,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -163284,6 +163298,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -163357,7 +163391,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -163402,6 +163437,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -163417,7 +163455,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163543,6 +163581,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163637,6 +163678,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163850,6 +163894,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164108,6 +164155,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164467,6 +164517,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -164536,7 +164606,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -164581,6 +164652,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164807,7 +164881,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -164992,6 +165067,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165322,6 +165400,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165416,6 +165497,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165630,6 +165714,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165891,6 +165978,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166251,6 +166341,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -166320,7 +166430,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -166365,6 +166476,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166404,7 +166518,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166440,7 +166554,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166923,6 +167037,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -167176,6 +167293,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -167522,6 +167642,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -167595,7 +167735,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -167641,6 +167782,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -167653,7 +167797,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167777,6 +167921,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167871,6 +168018,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168084,6 +168234,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168342,6 +168495,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168701,6 +168857,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -168770,7 +168946,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -168815,6 +168992,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169042,7 +169222,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -169227,6 +169408,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169467,7 +169651,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169508,7 +169692,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169547,7 +169731,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169702,6 +169886,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -169796,6 +169983,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -170031,6 +170221,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -170282,6 +170475,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -170626,6 +170822,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -170699,7 +170915,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -170744,6 +170961,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -170756,7 +170976,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170792,7 +171012,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170828,7 +171048,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170863,7 +171083,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170941,7 +171161,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170965,7 +171185,6 @@ "type": "object", "properties": { "permission": { - "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.", "type": "object", "properties": { "to": { @@ -170980,18 +171199,6 @@ "required": [ "to" ] - }, - "role_name": { - "description": "The role assigned to the collaborator.", - "type": "object", - "properties": { - "to": { - "type": "string" - } - }, - "required": [ - "to" - ] } } }, @@ -171011,7 +171218,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171078,7 +171285,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171115,7 +171322,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171242,6 +171449,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171380,6 +171590,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171549,7 +171762,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171584,7 +171797,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171620,7 +171833,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171656,7 +171869,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171734,7 +171947,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171771,7 +171984,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171807,7 +172020,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171842,7 +172055,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171981,6 +172194,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172026,7 +172242,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -172065,7 +172281,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172114,7 +172330,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172305,6 +172521,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172404,6 +172623,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172840,6 +173062,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172989,7 +173214,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173129,6 +173354,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173227,6 +173455,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173437,6 +173668,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173592,7 +173826,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173717,6 +173951,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173762,7 +173999,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173785,11 +174022,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -173816,11 +174056,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -173847,11 +174090,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -173861,8 +174107,7 @@ "action", "personal_access_token_request", "organization", - "sender", - "installation" + "sender" ] }, "webhook-personal-access-token-request-denied": { @@ -173881,8 +174126,11 @@ "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -174000,7 +174248,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "zen": { "description": "Random string of GitHub zen.", @@ -174066,7 +174314,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174102,7 +174350,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174244,6 +174492,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174293,7 +174544,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174348,7 +174599,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174511,6 +174762,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174665,7 +174919,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174700,7 +174954,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174735,7 +174989,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174769,7 +175023,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174819,7 +175073,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174854,7 +175108,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174889,7 +175143,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174924,7 +175178,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -174988,7 +175242,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175022,7 +175276,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175051,7 +175305,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175081,7 +175335,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175111,7 +175365,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175194,7 +175448,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175228,7 +175482,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175276,7 +175530,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175307,7 +175561,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175337,7 +175591,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175358,6 +175612,7 @@ ] }, "changes": { + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes the GraphQL node ID of the changed field.", "oneOf": [ { "type": "object", @@ -175411,7 +175666,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175459,7 +175714,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175493,7 +175748,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175524,7 +175779,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175551,7 +175806,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175807,6 +176062,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175902,6 +176160,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176026,6 +176287,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176254,7 +176518,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -176456,6 +176721,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176595,7 +176863,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -176739,7 +177007,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -176784,6 +177053,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177047,7 +177319,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -177249,6 +177522,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177388,7 +177664,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -177532,7 +177808,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -177577,6 +177854,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177760,6 +178040,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177871,6 +178154,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178053,6 +178339,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178408,7 +178697,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -178454,6 +178744,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178505,7 +178798,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178761,6 +179054,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178979,6 +179275,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179207,7 +179506,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -179409,6 +179709,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179548,7 +179851,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -179692,7 +179995,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -179737,6 +180041,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179998,7 +180305,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -180200,6 +180508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180339,7 +180650,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -180483,7 +180794,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -180528,6 +180840,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180711,6 +181026,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180821,6 +181139,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181003,6 +181324,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181358,7 +181682,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -181404,6 +181729,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181458,7 +181786,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181714,6 +182042,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181932,6 +182263,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182160,7 +182494,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -182362,6 +182697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182501,7 +182839,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -182645,7 +182983,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -182690,6 +183029,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183153,6 +183495,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183292,7 +183637,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -183436,7 +183781,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -183481,6 +183827,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183664,6 +184013,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183775,6 +184127,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183957,6 +184312,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184312,7 +184670,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184358,6 +184717,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184412,7 +184774,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184452,7 +184814,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184492,7 +184854,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184532,7 +184894,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184632,7 +184994,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184891,6 +185253,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185110,6 +185475,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185338,7 +185706,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -185540,6 +185909,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185679,7 +186051,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -185823,7 +186195,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -185868,6 +186241,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186131,7 +186507,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -186333,6 +186710,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186472,7 +186852,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -186616,7 +186996,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -186661,6 +187042,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186845,6 +187229,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186956,6 +187343,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187138,6 +187528,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187493,7 +187886,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187539,6 +187933,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187590,7 +187987,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -187845,6 +188242,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188064,6 +188464,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188292,7 +188695,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -188494,6 +188898,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188633,7 +189040,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -188777,7 +189184,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -188822,6 +189230,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189085,7 +189496,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -189287,6 +189699,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189426,7 +189841,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -189570,7 +189985,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -189615,6 +190031,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189799,6 +190218,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189909,6 +190331,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190091,6 +190516,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190446,7 +190874,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -190492,6 +190921,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190543,7 +190975,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -190583,7 +191015,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -190622,7 +191054,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -190662,7 +191094,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -190702,7 +191134,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -190997,7 +191429,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -191042,6 +191475,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191306,6 +191742,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191525,6 +191964,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191753,7 +192195,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -191955,6 +192398,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192094,7 +192540,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -192238,7 +192684,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -192283,6 +192730,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192530,7 +192980,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -192732,6 +193183,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192871,7 +193325,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -193014,7 +193468,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193059,6 +193514,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193245,6 +193703,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193422,6 +193883,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193771,7 +194235,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193817,6 +194282,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193866,7 +194334,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -194117,6 +194585,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194335,6 +194806,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194563,7 +195037,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -194765,6 +195240,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194904,7 +195382,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -195048,7 +195526,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -195093,6 +195572,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195340,7 +195822,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -195542,6 +196025,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195681,7 +196167,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -195825,7 +196311,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -195870,6 +196357,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196055,6 +196545,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196231,6 +196724,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196571,7 +197067,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196617,6 +197114,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196666,7 +197166,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -196920,6 +197420,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197014,6 +197517,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197138,6 +197644,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197366,7 +197875,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -197568,6 +198078,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197707,7 +198220,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -197851,7 +198364,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -197896,6 +198410,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198143,7 +198660,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -198345,6 +198863,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198484,7 +199005,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -198628,7 +199149,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -198673,6 +199195,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198859,6 +199384,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199035,6 +199563,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199375,7 +199906,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199418,6 +199950,9 @@ "Mannequin" ] }, + "user_view_type": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -199470,7 +200005,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -199721,6 +200256,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199940,6 +200478,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200168,7 +200709,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -200370,6 +200912,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200509,7 +201054,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -200653,7 +201198,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -200698,6 +201244,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200945,7 +201494,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -201147,6 +201697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201286,7 +201839,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -201430,7 +201983,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -201475,6 +202029,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201660,6 +202217,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201837,6 +202397,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202186,7 +202749,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202232,6 +202796,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202412,7 +202979,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202458,6 +203026,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202481,7 +203052,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -202748,6 +203319,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202967,6 +203541,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203190,7 +203767,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -203375,6 +203953,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203631,7 +204212,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -203676,6 +204258,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203918,7 +204503,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -204103,6 +204689,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204359,7 +204948,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -204404,6 +204994,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204590,6 +205183,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204767,6 +205363,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205116,7 +205715,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -205162,6 +205762,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205216,7 +205819,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -205475,6 +206078,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205569,6 +206175,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205693,6 +206302,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205921,7 +206533,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -206123,6 +206736,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206262,7 +206878,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -206406,7 +207022,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -206451,6 +207068,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206712,7 +207332,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -206914,6 +207535,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207053,7 +207677,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -207197,7 +207821,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -207242,6 +207867,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207425,6 +208053,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207535,6 +208166,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207716,6 +208350,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208080,7 +208717,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -208125,6 +208763,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208260,6 +208901,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208268,7 +208912,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -208524,6 +209168,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208618,6 +209265,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208742,6 +209392,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208970,7 +209623,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -209172,6 +209826,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209311,7 +209968,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -209455,7 +210112,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -209500,6 +210158,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209761,7 +210422,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -209963,6 +210625,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210102,7 +210767,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -210246,7 +210911,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -210291,6 +210957,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210474,6 +211143,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210584,6 +211256,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210765,6 +211440,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211129,7 +211807,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -211174,6 +211853,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211363,7 +212045,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -211625,6 +212307,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211720,6 +212405,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211844,6 +212532,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212072,7 +212763,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -212274,6 +212966,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212413,7 +213108,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -212557,7 +213252,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -212602,6 +213298,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212863,7 +213562,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -213065,6 +213765,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213204,7 +213907,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -213348,7 +214051,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -213393,6 +214097,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213576,6 +214283,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213687,6 +214397,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213868,6 +214581,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214223,7 +214939,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214269,6 +214986,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214405,6 +215125,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214413,7 +215136,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -214670,6 +215393,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214765,6 +215491,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214889,6 +215618,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215117,7 +215849,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -215319,6 +216052,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215458,7 +216194,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -215602,7 +216338,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -215647,6 +216384,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215908,7 +216648,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -216110,6 +216851,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216249,7 +216993,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -216393,7 +217137,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -216438,6 +217183,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216621,6 +217369,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216732,6 +217483,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216913,6 +217667,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217259,7 +218016,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217305,6 +218063,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217485,7 +218246,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -217738,6 +218499,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217957,6 +218721,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218185,7 +218952,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -218387,6 +219155,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218526,7 +219297,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -218670,7 +219441,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -218715,6 +219487,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218963,7 +219738,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -219165,6 +219941,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219304,7 +220083,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -219448,7 +220227,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -219493,6 +220273,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219679,6 +220462,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219856,6 +220642,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220205,7 +220994,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220251,6 +221041,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220305,7 +221098,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -220554,6 +221347,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220772,6 +221568,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221000,7 +221799,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -221185,6 +221985,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221446,7 +222249,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -221491,6 +222295,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221739,7 +222546,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -221924,6 +222732,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222185,7 +222996,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222230,6 +223042,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222415,6 +223230,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222592,6 +223410,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222941,7 +223762,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222987,6 +223809,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223038,7 +223863,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -223319,7 +224144,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -223365,6 +224191,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223657,6 +224486,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223874,6 +224706,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224102,7 +224937,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -224287,6 +225123,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224548,7 +225387,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -224593,6 +225433,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224839,7 +225682,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -225024,6 +225868,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225285,7 +226132,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -225330,6 +226178,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225515,6 +226366,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225691,6 +226545,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226031,7 +226888,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226076,6 +226934,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226127,7 +226988,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -226407,7 +227268,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226452,6 +227314,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226757,6 +227622,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226976,6 +227844,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227204,7 +228075,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -227406,6 +228278,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227545,7 +228420,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -227689,7 +228564,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -227734,6 +228610,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227995,7 +228874,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -228197,6 +229077,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228336,7 +229219,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -228480,7 +229363,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -228525,6 +229409,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228708,6 +229595,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228819,6 +229709,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229001,6 +229894,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229356,7 +230252,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -229402,6 +230299,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229453,7 +230353,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -229714,6 +230614,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229933,6 +230836,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230162,7 +231068,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -230364,6 +231271,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230503,7 +231413,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -230647,7 +231557,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -230692,6 +231603,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230955,7 +231869,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -231157,6 +232072,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231296,7 +232214,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -231440,7 +232358,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -231485,6 +232404,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231669,6 +232591,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231780,6 +232705,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231962,6 +232890,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232317,7 +233248,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -232363,6 +233295,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232414,7 +233349,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232672,6 +233607,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232891,6 +233829,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233119,7 +234060,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -233321,6 +234263,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233460,7 +234405,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -233604,7 +234549,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -233649,6 +234595,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233912,7 +234861,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -234114,6 +235064,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234253,7 +235206,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -234397,7 +235350,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -234442,6 +235396,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234625,6 +235582,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234736,6 +235696,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234918,6 +235881,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235273,7 +236239,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -235319,6 +236286,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235370,7 +236340,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235625,6 +236595,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235842,6 +236815,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236070,7 +237046,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -236272,6 +237249,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236411,7 +237391,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -236555,7 +237535,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -236600,6 +237581,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236862,7 +237846,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -237064,6 +238049,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237203,7 +238191,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -237347,7 +238335,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -237392,6 +238381,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237575,6 +238567,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237685,6 +238680,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237866,6 +238864,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238212,7 +239213,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -238257,6 +239259,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238308,7 +239313,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238819,7 +239824,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -239004,6 +240010,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239223,7 +240232,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239341,6 +240350,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239427,6 +240439,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239886,6 +240901,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -240005,7 +241023,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240112,6 +241130,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240197,6 +241218,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240380,6 +241404,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240520,7 +241547,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240555,7 +241582,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240591,7 +241618,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240668,7 +241695,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240978,6 +242005,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -241105,7 +242135,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241140,7 +242170,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241175,7 +242205,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241210,7 +242240,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241241,7 +242271,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241270,7 +242300,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241300,7 +242330,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241332,7 +242362,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241364,7 +242394,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241403,7 +242433,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241490,7 +242520,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241523,7 +242553,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241555,7 +242585,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241614,7 +242644,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241650,7 +242680,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241685,7 +242715,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241869,7 +242899,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242006,7 +243036,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -242051,6 +243082,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242083,7 +243117,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242116,7 +243150,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242151,7 +243185,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242300,6 +243334,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -242357,7 +243394,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242393,7 +243430,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242593,7 +243630,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242629,7 +243666,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242664,7 +243701,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242713,7 +243750,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242748,42 +243785,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" - } - }, - "required": [ - "action", - "alert", - "repository" - ] - }, - "webhook-secret-scanning-alert-revoked": { - "title": "secret_scanning_alert revoked event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "revoked" - ] - }, - "alert": { - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - }, - "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" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242818,7 +243820,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242852,7 +243854,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -242902,6 +243904,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -243038,7 +244043,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -243076,7 +244081,7 @@ "$ref": "#/components/schemas/full-repository" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -243107,7 +244112,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -243142,7 +244147,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -243194,7 +244199,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -243233,7 +244238,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -243274,7 +244279,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -243313,7 +244318,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -243349,7 +244354,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -243387,7 +244392,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -243891,7 +244896,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sha": { "description": "The Commit SHA.", @@ -243949,7 +244954,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -244170,7 +245175,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -244355,6 +245361,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244569,7 +245578,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -244790,7 +245799,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -244975,6 +245985,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245189,7 +246202,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -245411,7 +246424,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -245596,6 +246610,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245810,7 +246827,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -246118,7 +247135,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -246303,6 +247321,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -246517,7 +247538,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -246740,7 +247761,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -246925,6 +247947,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -247139,7 +248164,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -247174,7 +248199,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -247206,7 +248231,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -247239,7 +248264,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -247273,7 +248298,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "type": "string" @@ -247310,7 +248335,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -247641,7 +248666,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -248004,7 +249029,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -248212,7 +249237,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -248421,7 +249446,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -248554,6 +249579,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -248586,7 +249614,8 @@ "skipped", "stale", "success", - "timed_out" + "timed_out", + "startup_failure" ] }, "created_at": { @@ -248954,6 +249983,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -249432,6 +250464,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -249595,6 +250630,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -249652,7 +250690,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -250878,7 +251916,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -250972,6 +252010,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251326,6 +252367,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -251803,6 +252847,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -252014,6 +253061,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -252485,7 +253535,7 @@ "allow_downstream_configuration": true } }, - "authorization-items": { + "classic-personal-access-tokens": { "value": [ { "id": 2, @@ -252615,12 +253665,28 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], "credits": [ { "user": { @@ -252696,6 +253762,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", @@ -252733,6 +253809,7 @@ "value": { "id": 1, "slug": "octoapp", + "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", @@ -252840,7 +253917,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, @@ -252853,7 +253931,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": null } ] }, @@ -252871,6 +253950,7 @@ "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -253343,6 +254423,42 @@ } } }, + "authorization-items": { + "value": [ + { + "id": 2, + "url": "https://enterprise.octocat.com/api/v3/authorizations/2", + "app": { + "name": "My personal access token", + "url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens", + "client_id": "00000000000000000000" + }, + "token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a", + "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45", + "token_last_eight": "Ae178B4a", + "note": "My personal access token", + "note_url": null, + "created_at": "2019-04-24T21:49:02Z", + "updated_at": "2019-04-24T21:49:02Z", + "scopes": [ + "admin:business", + "admin:gpg_key", + "admin:org", + "admin:org_hook", + "admin:pre_receive_hook", + "admin:public_key", + "admin:repo_hook", + "delete_repo", + "gist", + "notifications", + "repo", + "user", + "write:discussion" + ], + "fingerprint": null + } + ] + }, "authorization-response-if-returning-an-existing-token-2": { "value": { "id": 1, @@ -256242,6 +257358,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -256442,6 +257568,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -256686,6 +257822,29 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", "validity": "active" }, @@ -256772,6 +257931,10 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, "validity": "unknown" } @@ -256994,7 +258157,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -257002,7 +258166,6 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", @@ -257960,6 +259123,90 @@ ] } }, + "ghes-cluster-status": { + "value": { + "status": "OK", + "nodes": [ + { + "hostname": "ghe-local-app", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "es", + "details": "Elasticsearch cluster is in sync (0 shards initializing, 0 shards unassigned)" + }, + { + "status": "OK", + "name": "git-replication", + "details": "Git replication is in sync" + }, + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + }, + { + "status": "OK", + "name": "memcache", + "details": "" + }, + { + "status": "OK", + "name": "metrics", + "details": "" + }, + { + "status": "OK", + "name": "mysql-replication", + "details": "Replication is running" + }, + { + "status": "OK", + "name": "mysql-failover", + "details": "" + }, + { + "status": "OK", + "name": "pages", + "details": "Pages replication is in sync" + }, + { + "status": "OK", + "name": "redis", + "details": "Redis is OK" + }, + { + "status": "OK", + "name": "storage", + "details": "Storage replication is in sync" + } + ] + }, + { + "hostname": "ghe-local-app2", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + } + ] + } + ] + } + }, "ghes-license-info": { "value": [ { @@ -258280,9 +259527,6 @@ "packages": [ "192.0.2.1" ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -259701,6 +260945,7 @@ "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, + "client_id": "Iv1.ab1112223334445c", "target_id": 1, "target_type": "Organization", "permissions": { @@ -260567,6 +261812,8 @@ } }, "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -260608,6 +261855,8 @@ } }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -261350,7 +262599,7 @@ { "id": 21, "actor_id": 12, - "username": "octocat", + "actor_name": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", @@ -261362,7 +262611,7 @@ { "id": 25, "actor_id": 11, - "username": "not-octocat", + "actor_name": "not-octocat", "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", "ref": "refs/heads/i-am-everything", @@ -261378,7 +262627,7 @@ "value": { "id": 21, "actor_id": 12, - "username": "octocat", + "actor_name": "octocat", "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", "ref": "refs/heads/i-see-everything", @@ -262330,6 +263579,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -262575,6 +263830,7 @@ "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, + "allow_forking": true, "subscribers_count": 42, "network_count": 0, "license": { @@ -264001,9 +265257,7 @@ "comment_count": 77, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", @@ -264621,9 +265875,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "comment_count": 0 }, @@ -266948,9 +268200,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -267376,9 +268626,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -267454,9 +268702,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -267804,9 +269050,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -267858,16 +269102,13 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } }, "file-commit": { "value": { - "content": null, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -267897,9 +269138,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -267976,6 +269215,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -268109,6 +269358,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -268220,6 +269479,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -268319,6 +269588,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -268478,10 +269757,7 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { "SPDXID": "SPDXRef-Package", @@ -268489,8 +269765,20 @@ "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, - "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseConcluded": "NOASSERTION", + "licenseDeclared": "NOASSERTION" + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -269196,9 +270484,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } @@ -269233,9 +270519,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -269294,9 +270578,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -270679,19 +271961,21 @@ ] }, "deploy-key-items": { - "value": [ - { - "id": 1, - "key": "ssh-rsa AAA...", - "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", - "title": "octocat@octomac", - "verified": true, - "created_at": "2014-12-10T15:53:42Z", - "read_only": true, - "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" - } - ] + "value": { + "enabled": [ + { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z" + } + ] + } }, "deploy-key": { "value": { @@ -270860,6 +272144,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -273655,6 +274941,29 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", "validity": "inactive" }, @@ -273674,6 +274983,10 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, "resolution_comment": null, "validity": "unknown" } @@ -273687,16 +275000,10 @@ "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed_by": null, "push_protection_bypassed": false, - "push_protection_bypassed_at": null, - "resolution_comment": null, "validity": "unknown" } }, @@ -273734,8 +275041,6 @@ "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed": false, - "push_protection_bypassed_by": null, - "push_protection_bypassed_at": null, "resolution_comment": "Example comment", "validity": "unknown" } @@ -273809,7 +275114,7 @@ { "type": "pull_request_title", "details": { - "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, { @@ -274487,7 +275792,7 @@ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "id": "927fa2c08dcb4a7fae9e", + "id": "24b28bbb-5fc4-4686-a153-a020debb1155", "displayName": "Engineering", "members": [ { @@ -274505,7 +275810,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } ], @@ -274537,7 +275842,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } }, @@ -279085,9 +280390,6 @@ "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, "secret_type": "mailchimp_api_key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" }, @@ -279677,7 +280979,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", + "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.12/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -279758,7 +281060,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "labels": { @@ -279770,15 +281073,6 @@ "type": "string" } }, - "license-apply": { - "name": "apply", - "description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } - }, "uuid": { "name": "uuid", "description": "The UUID which identifies a node.", @@ -279935,6 +281229,24 @@ "type": "integer" } }, + "members-per-page": { + "name": "per_page", + "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + "members-page": { + "name": "page", + "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, "migration-id": { "name": "migration_id", "description": "The unique identifier of the migration.", @@ -280078,12 +281390,31 @@ "type": "integer" } }, + "ruleset-targets": { + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "branch,tag,push" + } + }, + "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 + }, "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.", + "description": "The name of the repository to filter on.", "in": "query", "schema": { - "type": "integer" + "type": "string" } }, "time-period": { @@ -280704,15 +282035,6 @@ "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.", @@ -280850,6 +282172,15 @@ "default": "created" } }, + "account-id": { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "since-user": { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.", diff --git a/cache/ghes-3.11.json b/cache/ghes-3.13.json similarity index 94% rename from cache/ghes-3.11.json rename to cache/ghes-3.13.json index b55221229..dbd4b52e4 100644 --- a/cache/ghes-3.11.json +++ b/cache/ghes-3.13.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.6.0", + "version": "17.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": { @@ -14,7 +14,7 @@ "url": "https://github.com/octokit/openapi" }, "x-github-plan": "ghes", - "x-github-release": 3.11 + "x-github-release": 3.13 }, "tags": [ { @@ -148,6 +148,14 @@ { "name": "enterprise-admin", "description": "Enterprise Administration" + }, + { + "name": "oauth-authorizations", + "description": "OAuth Authorizations API" + }, + { + "name": "security-advisories", + "description": "Manage security advisories." } ], "servers": [ @@ -167,7 +175,7 @@ ], "externalDocs": { "description": "GitHub Enterprise Developer Docs", - "url": "https://docs.github.com/enterprise-server@3.11/rest/" + "url": "https://docs.github.com/enterprise-server@3.13/rest/" }, "paths": { "/": { @@ -203,7 +211,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/meta/meta#github-api-root" + "url": "https://docs.github.com/enterprise-server@3.13/rest/meta/meta#github-api-root" }, "x-octokit": {} } @@ -218,7 +226,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/global-webhooks#list-global-webhooks" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#list-global-webhooks" }, "parameters": [ { @@ -270,7 +278,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/global-webhooks#create-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#create-a-global-webhook" }, "responses": { "201": { @@ -314,7 +322,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers) header." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers) header." }, "insecure_ssl": { "type": "string", @@ -327,7 +335,7 @@ }, "events": { "type": "array", - "description": "The [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "description": "The [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } @@ -381,7 +389,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/global-webhooks#get-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#get-a-global-webhook" }, "parameters": [ { @@ -422,7 +430,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/global-webhooks#update-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#update-a-global-webhook" }, "parameters": [ { @@ -467,7 +475,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers) header." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers) header." }, "insecure_ssl": { "type": "string", @@ -480,7 +488,7 @@ }, "events": { "type": "array", - "description": "The [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "description": "The [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } @@ -524,7 +532,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/global-webhooks#delete-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#delete-a-global-webhook" }, "parameters": [ { @@ -548,14 +556,14 @@ "/admin/hooks/{hook_id}/pings": { "post": { "summary": "Ping a global webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the webhook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) to be sent to the webhook.", "operationId": "enterprise-admin/ping-global-webhook", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/global-webhooks#ping-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#ping-a-global-webhook" }, "parameters": [ { @@ -586,7 +594,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#list-public-keys" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#list-public-keys" }, "parameters": [ { @@ -666,7 +674,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#delete-a-public-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-a-public-key" }, "parameters": [ { @@ -690,14 +698,14 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team" }, "parameters": [ { @@ -766,7 +774,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team" }, "parameters": [ { @@ -816,7 +824,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user" }, "parameters": [ { @@ -885,7 +893,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user" }, "parameters": [ { @@ -935,7 +943,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/orgs#create-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/orgs#create-an-organization" }, "responses": { "201": { @@ -1010,7 +1018,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/orgs#update-an-organization-name" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/orgs#update-an-organization-name" }, "parameters": [ { @@ -1090,7 +1098,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments" }, "parameters": [ { @@ -1154,7 +1162,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment" }, "responses": { "201": { @@ -1224,7 +1232,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment" }, "parameters": [ { @@ -1265,7 +1273,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment" }, "parameters": [ { @@ -1380,7 +1388,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment" }, "parameters": [ { @@ -1457,7 +1465,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download" }, "parameters": [ { @@ -1546,7 +1554,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment" }, "parameters": [ { @@ -1589,7 +1597,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks" }, "parameters": [ { @@ -1654,7 +1662,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook" }, "responses": { "201": { @@ -1754,7 +1762,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook" }, "parameters": [ { @@ -1795,7 +1803,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook" }, "parameters": [ { @@ -1887,7 +1895,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook" }, "parameters": [ { @@ -1918,7 +1926,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#list-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#list-personal-access-tokens" }, "parameters": [ { @@ -1941,7 +1949,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/authorization-items" + "$ref": "#/components/examples/classic-personal-access-tokens" } } } @@ -1972,7 +1980,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#delete-a-personal-access-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-a-personal-access-token" }, "parameters": [ { @@ -1996,14 +2004,14 @@ "/admin/users": { "post": { "summary": "Create a user", - "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", + "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", "operationId": "enterprise-admin/create-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#create-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#create-a-user" }, "responses": { "201": { @@ -2035,7 +2043,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" }, "suspended": { "type": "boolean", @@ -2077,7 +2085,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#update-the-username-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#update-the-username-for-a-user" }, "parameters": [ { @@ -2148,14 +2156,14 @@ }, "delete": { "summary": "Delete a user", - "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", + "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", "operationId": "enterprise-admin/delete-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#delete-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-a-user" }, "parameters": [ { @@ -2186,7 +2194,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#create-an-impersonation-oauth-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#create-an-impersonation-oauth-token" }, "parameters": [ { @@ -2234,7 +2242,7 @@ "properties": { "scopes": { "type": "array", - "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "items": { "type": "string" } @@ -2273,7 +2281,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#delete-an-impersonation-oauth-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-an-impersonation-oauth-token" }, "parameters": [ { @@ -2297,14 +2305,14 @@ "/advisories": { "get": { "summary": "List global security advisories", - "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", + "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.13/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", "tags": [ "security-advisories" ], "operationId": "security-advisories/list-global-advisories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/security-advisories/global-advisories#list-global-security-advisories" + "url": "https://docs.github.com/enterprise-server@3.13/rest/security-advisories/global-advisories#list-global-security-advisories" }, "parameters": [ { @@ -2408,7 +2416,7 @@ { "name": "published", "in": "query", - "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { "type": "string" } @@ -2416,15 +2424,31 @@ { "name": "updated", "in": "query", - "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "schema": { "type": "string" } }, { "name": "modified", - "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", "schema": { "type": "string" } @@ -2440,7 +2464,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -2458,7 +2482,9 @@ "type": "string", "enum": [ "updated", - "published" + "published", + "epss_percentage", + "epss_percentile" ], "default": "published" } @@ -2516,7 +2542,7 @@ "operationId": "security-advisories/get-global-advisory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/security-advisories/global-advisories#get-a-global-security-advisory" + "url": "https://docs.github.com/enterprise-server@3.13/rest/security-advisories/global-advisories#get-a-global-security-advisory" }, "parameters": [ { @@ -2555,14 +2581,14 @@ "/app": { "get": { "summary": "Get the authenticated app", - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-the-authenticated-app" }, "parameters": [], "responses": { @@ -2594,14 +2620,14 @@ "/app-manifests/{code}/conversions": { "post": { "summary": "Create a GitHub App from a manifest", - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "tags": [ "apps" ], "operationId": "apps/create-from-manifest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-a-github-app-from-a-manifest" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#create-a-github-app-from-a-manifest" }, "parameters": [ { @@ -2677,14 +2703,14 @@ "/app/hook/config": { "get": { "summary": "Get a webhook configuration for an app", - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" }, "responses": { "200": { @@ -2713,14 +2739,14 @@ }, "patch": { "summary": "Update a webhook configuration for an app", - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/update-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" }, "requestBody": { "required": true, @@ -2785,14 +2811,14 @@ "/app/hook/deliveries": { "get": { "summary": "List deliveries for an app webhook", - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/webhooks#list-deliveries-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/webhooks#list-deliveries-for-an-app-webhook" }, "parameters": [ { @@ -2800,14 +2826,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -2848,14 +2866,14 @@ "/app/hook/deliveries/{delivery_id}": { "get": { "summary": "Get a delivery for an app webhook", - "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -2897,14 +2915,14 @@ "/app/hook/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an app webhook", - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -2941,7 +2959,7 @@ "operationId": "apps/list-installation-requests-for-authenticated-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#list-installation-requests-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#list-installation-requests-for-the-authenticated-app" }, "parameters": [ { @@ -3761,14 +3779,14 @@ "/app/installations/{installation_id}": { "get": { "summary": "Get an installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -3805,14 +3823,14 @@ }, "delete": { "summary": "Delete an installation for the authenticated app", - "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/delete-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#delete-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#delete-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -3839,14 +3857,14 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/create-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-an-installation-access-token-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#create-an-installation-access-token-for-an-app" }, "parameters": [ { @@ -3940,14 +3958,14 @@ "/app/installations/{installation_id}/suspended": { "put": { "summary": "Suspend an app installation", - "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/suspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#suspend-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#suspend-an-app-installation" }, "parameters": [ { @@ -3972,14 +3990,14 @@ }, "delete": { "summary": "Unsuspend an app installation", - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/unsuspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#unsuspend-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#unsuspend-an-app-installation" }, "parameters": [ { @@ -4006,14 +4024,14 @@ "/applications/grants": { "get": { "summary": "List your grants", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/list-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-grants" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-grants" }, "parameters": [ { @@ -4084,14 +4102,14 @@ "/applications/grants/{grant_id}": { "get": { "summary": "Get a single grant", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-grant", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant" }, "parameters": [ { @@ -4137,14 +4155,14 @@ }, "delete": { "summary": "Delete a grant", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/delete-grant", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#delete-a-grant" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#delete-a-grant" }, "parameters": [ { @@ -4180,14 +4198,14 @@ "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", - "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/oauth-applications#delete-an-app-authorization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/oauth-applications#delete-an-app-authorization" }, "parameters": [ { @@ -4240,14 +4258,14 @@ "/applications/{client_id}/token": { "post": { "summary": "Check a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/check-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/oauth-applications#check-a-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/oauth-applications#check-a-token" }, "parameters": [ { @@ -4313,14 +4331,14 @@ }, "patch": { "summary": "Reset a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/reset-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/oauth-applications#reset-a-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/oauth-applications#reset-a-token" }, "parameters": [ { @@ -4383,14 +4401,14 @@ }, "delete": { "summary": "Delete an app token", - "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.", + "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], "operationId": "apps/delete-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/oauth-applications#delete-an-app-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/oauth-applications#delete-an-app-token" }, "parameters": [ { @@ -4443,14 +4461,14 @@ "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", - "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/scope-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-a-scoped-access-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#create-a-scoped-access-token" }, "parameters": [ { @@ -4562,14 +4580,14 @@ "/apps/{app_slug}": { "get": { "summary": "Get an app", - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", + "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "tags": [ "apps" ], "operationId": "apps/get-by-slug", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app" }, "parameters": [ { @@ -4611,14 +4629,14 @@ "/authorizations": { "get": { "summary": "List your authorizations", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/list-authorizations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations" }, "parameters": [ { @@ -4687,14 +4705,14 @@ }, "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.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/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.11/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.11/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.11/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.11/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.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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.13/rest/authentication/authenticating-to-the-rest-api#using-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.13/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.13/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.13/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" ], "operationId": "oauth-authorizations/create-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization" }, "parameters": [], "requestBody": { @@ -4813,14 +4831,14 @@ "/authorizations/clients/{client_id}": { "put": { "summary": "Get-or-create an authorization for a specific app", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-or-create-authorization-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app" }, "parameters": [ { @@ -4910,7 +4928,7 @@ } }, "201": { - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/).", "content": { "application/json": { "schema": { @@ -4960,14 +4978,14 @@ "/authorizations/clients/{client_id}/{fingerprint}": { "put": { "summary": "Get-or-create an authorization for a specific app and fingerprint", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" }, "parameters": [ { @@ -5102,14 +5120,14 @@ "/authorizations/{authorization_id}": { "get": { "summary": "Get a single authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization" }, "parameters": [ { @@ -5155,14 +5173,14 @@ }, "patch": { "summary": "Update an existing authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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\nIf 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.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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\nIf 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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/update-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization" }, "parameters": [ { @@ -5267,14 +5285,14 @@ }, "delete": { "summary": "Delete an authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/delete-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization" }, "parameters": [ { @@ -5317,7 +5335,7 @@ "operationId": "codes-of-conduct/get-all-codes-of-conduct", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" + "url": "https://docs.github.com/enterprise-server@3.13/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" }, "parameters": [], "responses": { @@ -5362,7 +5380,7 @@ "operationId": "codes-of-conduct/get-conduct-code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" + "url": "https://docs.github.com/enterprise-server@3.13/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" }, "parameters": [ { @@ -5416,7 +5434,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/emojis/emojis#get-emojis" + "url": "https://docs.github.com/enterprise-server@3.13/rest/emojis/emojis#get-emojis" }, "parameters": [], "responses": { @@ -5461,7 +5479,7 @@ "operationId": "enterprise-admin/get-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/announcement#get-the-global-announcement-banner" }, "responses": { "200": { @@ -5497,7 +5515,7 @@ "operationId": "enterprise-admin/set-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/announcement#set-the-global-announcement-banner" }, "requestBody": { "required": true, @@ -5551,7 +5569,7 @@ "operationId": "enterprise-admin/remove-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" }, "responses": { "204": { @@ -5577,7 +5595,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/license#get-license-information" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/license#get-license-information" }, "responses": { "200": { @@ -5615,7 +5633,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-all-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-all-statistics" }, "responses": { "200": { @@ -5653,7 +5671,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-comment-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-comment-statistics" }, "responses": { "200": { @@ -5696,7 +5714,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-gist-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-gist-statistics" }, "responses": { "200": { @@ -5737,7 +5755,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-hooks-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-hooks-statistics" }, "responses": { "200": { @@ -5779,7 +5797,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-issue-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-issue-statistics" }, "responses": { "200": { @@ -5821,7 +5839,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-milestone-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-milestone-statistics" }, "responses": { "200": { @@ -5863,7 +5881,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-organization-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-organization-statistics" }, "responses": { "200": { @@ -5906,7 +5924,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-pages-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-pages-statistics" }, "responses": { "200": { @@ -5946,7 +5964,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-pull-request-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-pull-request-statistics" }, "responses": { "200": { @@ -5988,7 +6006,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-repository-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-repository-statistics" }, "responses": { "200": { @@ -6033,7 +6051,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-security-products-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-security-products-statistics" }, "responses": { "200": { @@ -6071,7 +6089,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/admin-stats#get-users-statistics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-users-statistics" }, "responses": { "200": { @@ -6113,7 +6131,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" }, "parameters": [ { @@ -6161,7 +6179,7 @@ "operationId": "actions/get-actions-cache-usage-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise" }, "parameters": [ { @@ -6207,7 +6225,7 @@ "operationId": "actions/set-actions-cache-usage-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise" }, "parameters": [ { @@ -6253,7 +6271,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -6294,7 +6312,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -6354,7 +6372,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6416,7 +6434,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6480,7 +6498,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6512,7 +6530,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6546,7 +6564,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -6587,7 +6605,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -6626,14 +6644,14 @@ "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -6667,14 +6685,14 @@ }, "put": { "summary": "Set default workflow permissions for an enterprise", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -6720,7 +6738,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" }, "parameters": [ { @@ -6785,7 +6803,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6906,7 +6924,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6950,7 +6968,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -7046,7 +7064,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" }, "parameters": [ { @@ -7080,7 +7098,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -7145,7 +7163,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -7212,7 +7230,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -7247,7 +7265,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -7284,7 +7302,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -7354,7 +7372,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -7421,7 +7439,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" }, "parameters": [ { @@ -7456,7 +7474,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" }, "parameters": [ { @@ -7493,7 +7511,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" }, "parameters": [ { @@ -7566,7 +7584,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" }, "parameters": [ { @@ -7612,7 +7630,7 @@ "operationId": "actions/generate-runner-jitconfig-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" }, "parameters": [ { @@ -7685,7 +7703,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "actions", "subcategory": "self-hosted-runners" @@ -7703,7 +7721,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" }, "parameters": [ { @@ -7746,7 +7764,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" }, "parameters": [ { @@ -7789,7 +7807,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7833,7 +7851,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" }, "parameters": [ { @@ -7867,7 +7885,7 @@ "operationId": "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7902,7 +7920,7 @@ "operationId": "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7974,7 +7992,7 @@ "operationId": "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -8046,7 +8064,7 @@ "operationId": "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -8086,7 +8104,7 @@ "operationId": "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -8129,7 +8147,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" }, "parameters": [ { @@ -8199,14 +8217,14 @@ "/enterprises/{enterprise}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an enterprise", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -8308,7 +8326,7 @@ "operationId": "secret-scanning/get-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -8352,7 +8370,7 @@ "operationId": "secret-scanning/patch-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -8368,24 +8386,28 @@ "properties": { "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.11/get-started/learning-about-github/about-github-advanced-security).\"" + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.13/get-started/learning-about-github/about-github-advanced-security).\"" + }, + "advanced_security_enabled_new_user_namespace_repos": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.13/get-started/learning-about-github/about-github-advanced-security).\"" }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" + "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/about-secret-scanning).\"" + "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning).\"" }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" + "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" }, "secret_scanning_push_protection_custom_link": { "type": "string", "nullable": true, - "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." + "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." } } }, @@ -8393,6 +8415,7 @@ "default": { "value": { "advanced_security_enabled_for_new_repositories": true, + "advanced_security_enabled_new_user_namespace_repos": true, "dependabot_alerts_enabled_for_new_repositories": true, "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, @@ -8426,14 +8449,14 @@ "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", - "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", + "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" }, "parameters": [ { @@ -8521,14 +8544,14 @@ "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories.", "tags": [ "secret-scanning" ], "operationId": "secret-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -8557,6 +8580,9 @@ }, { "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -8609,7 +8635,7 @@ "operationId": "billing/get-github-advanced-security-billing-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" }, "parameters": [ { @@ -8637,9 +8663,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -8661,7 +8684,7 @@ "operationId": "secret-scanning/post-security-product-enablement-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" }, "parameters": [ { @@ -8697,14 +8720,14 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-public-events" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-public-events" }, "parameters": [ { @@ -8755,14 +8778,14 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/feeds#get-feeds" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/feeds#get-feeds" }, "parameters": [], "responses": { @@ -8801,7 +8824,7 @@ "operationId": "gists/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#list-gists-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#list-gists-for-the-authenticated-user" }, "parameters": [ { @@ -8855,14 +8878,14 @@ }, "post": { "summary": "Create a gist", - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "description": "Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", "operationId": "gists/create", "tags": [ "gists" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#create-a-gist" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#create-a-gist" }, "parameters": [], "requestBody": { @@ -8989,14 +9012,14 @@ "/gists/public": { "get": { "summary": "List public gists", - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "tags": [ "gists" ], "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#list-public-gists" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#list-public-gists" }, "parameters": [ { @@ -9062,7 +9085,7 @@ "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#list-starred-gists" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#list-starred-gists" }, "parameters": [ { @@ -9121,14 +9144,14 @@ "/gists/{gist_id}": { "get": { "summary": "Get a gist", - "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#get-a-gist" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#get-a-gist" }, "parameters": [ { @@ -9304,7 +9327,7 @@ "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#delete-a-gist" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#delete-a-gist" }, "parameters": [ { @@ -9337,14 +9360,14 @@ "/gists/{gist_id}/comments": { "get": { "summary": "List gist comments", - "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/comments#list-gist-comments" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/comments#list-gist-comments" }, "parameters": [ { @@ -9401,14 +9424,14 @@ }, "post": { "summary": "Create a gist comment", - "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/comments#create-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/comments#create-a-gist-comment" }, "parameters": [ { @@ -9490,14 +9513,14 @@ "/gists/{gist_id}/comments/{comment_id}": { "get": { "summary": "Get a gist comment", - "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/comments#get-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/comments#get-a-gist-comment" }, "parameters": [ { @@ -9543,14 +9566,14 @@ }, "patch": { "summary": "Update a gist comment", - "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/comments#update-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/comments#update-a-gist-comment" }, "parameters": [ { @@ -9626,7 +9649,7 @@ "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/comments#delete-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/comments#delete-a-gist-comment" }, "parameters": [ { @@ -9669,7 +9692,7 @@ "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#list-gist-commits" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#list-gist-commits" }, "parameters": [ { @@ -9738,7 +9761,7 @@ "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#list-gist-forks" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#list-gist-forks" }, "parameters": [ { @@ -9802,7 +9825,7 @@ "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#fork-a-gist" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#fork-a-gist" }, "parameters": [ { @@ -9865,7 +9888,7 @@ "operationId": "gists/check-is-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#check-if-a-gist-is-starred" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#check-if-a-gist-is-starred" }, "parameters": [ { @@ -9905,14 +9928,14 @@ }, "put": { "summary": "Star a gist", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "gists" ], "operationId": "gists/star", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#star-a-gist" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#star-a-gist" }, "parameters": [ { @@ -9950,7 +9973,7 @@ "operationId": "gists/unstar", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#unstar-a-gist" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#unstar-a-gist" }, "parameters": [ { @@ -9983,14 +10006,14 @@ "/gists/{gist_id}/{sha}": { "get": { "summary": "Get a gist revision", - "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#get-a-gist-revision" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#get-a-gist-revision" }, "parameters": [ { @@ -10043,14 +10066,14 @@ "/gitignore/templates": { "get": { "summary": "Get all gitignore templates", - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-for-the-authenticated-user).", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-for-the-authenticated-user).", "operationId": "gitignore/get-all-templates", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gitignore/gitignore#get-all-gitignore-templates" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gitignore/gitignore#get-all-gitignore-templates" }, "parameters": [], "responses": { @@ -10096,14 +10119,14 @@ "/gitignore/templates/{name}": { "get": { "summary": "Get a gitignore template", - "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", + "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", "operationId": "gitignore/get-template", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gitignore/gitignore#get-a-gitignore-template" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gitignore/gitignore#get-a-gitignore-template" }, "parameters": [ { @@ -10154,7 +10177,7 @@ "operationId": "apps/list-repos-accessible-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/installations#list-repositories-accessible-to-the-app-installation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/installations#list-repositories-accessible-to-the-app-installation" }, "parameters": [ { @@ -10226,14 +10249,14 @@ "/installation/token": { "delete": { "summary": "Revoke an installation access token", - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", "tags": [ "apps" ], "operationId": "apps/revoke-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/installations#revoke-an-installation-access-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/installations#revoke-an-installation-access-token" }, "parameters": [], "responses": { @@ -10253,14 +10276,14 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -10405,14 +10428,14 @@ "/licenses": { "get": { "summary": "Get all commonly used licenses", - "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get-all-commonly-used", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/licenses/licenses#get-all-commonly-used-licenses" + "url": "https://docs.github.com/enterprise-server@3.13/rest/licenses/licenses#get-all-commonly-used-licenses" }, "parameters": [ { @@ -10465,14 +10488,14 @@ "/licenses/{license}": { "get": { "summary": "Get a license", - "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/licenses/licenses#get-a-license" + "url": "https://docs.github.com/enterprise-server@3.13/rest/licenses/licenses#get-a-license" }, "parameters": [ { @@ -10519,17 +10542,17 @@ "x-octokit": {} } }, - "/manage/v1/config/nodes": { + "/manage/v1/access/ssh": { "get": { - "summary": "Get GHES node metadata for all nodes", - "description": "Get node metadata for all configured nodes in the current cluster. For more information, see \"[About clustering](https://docs.github.com/enterprise-server@3.11/admin/enterprise-management/configuring-clustering/about-clustering).\"", - "operationId": "enterprise-admin/get-config-nodes", + "summary": "Get the configured SSH keys", + "description": "Gets the configured SSH keys on all available nodes. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/get-manage-ssh", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys" }, "servers": [ { @@ -10546,35 +10569,27 @@ } } ], - "parameters": [ - { - "$ref": "#/components/parameters/uuid" - }, - { - "$ref": "#/components/parameters/cluster-roles" - } - ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ghes-config-nodes" + "$ref": "#/components/schemas/ghes-get-ssh" }, "examples": { "default": { - "$ref": "#/components/examples/ghes-config-nodes" + "$ref": "#/components/examples/ghes-get-ssh" } } } } }, + "400": { + "description": "Bad request" + }, "401": { "description": "Unauthorized" - }, - "500": { - "description": "Internal error" } }, "x-github": { @@ -10584,19 +10599,17 @@ "subcategory": "manage-ghes" }, "x-octokit": {} - } - }, - "/manage/v1/maintenance": { - "get": { - "summary": "Get the status of maintenance mode", - "description": "Gets the status and details of maintenance mode on all available nodes. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", - "operationId": "enterprise-admin/get-manage-maintenance", + }, + "post": { + "summary": "Set a new SSH key", + "description": "Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/set-manage-ssh", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key" }, "servers": [ { @@ -10613,25 +10626,34 @@ } } ], - "parameters": [ - { - "$ref": "#/components/parameters/uuid" - }, - { - "$ref": "#/components/parameters/cluster-roles" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-ssh-request" + }, + "examples": { + "default": { + "value": { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" + } + } + } + } } - ], + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ghes-get-maintenance" + "$ref": "#/components/schemas/ghes-set-ssh-response" }, "examples": { "default": { - "$ref": "#/components/examples/ghes-get-maintenance" + "$ref": "#/components/examples/ghes-set-ssh" } } } @@ -10655,16 +10677,16 @@ }, "x-octokit": {} }, - "post": { - "summary": "Set the status of maintenance mode", - "description": "Sets or schedules the maintenance mode. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", - "operationId": "enterprise-admin/set-manage-maintenance", + "delete": { + "summary": "Delete a SSH key", + "description": "Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/delete-manage-ssh", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#delete-a-ssh-key" }, "servers": [ { @@ -10686,17 +10708,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ghes-set-maintenance-request" + "$ref": "#/components/schemas/ghes-delete-ssh-request" }, "examples": { "default": { "value": { - "enabled": true, - "when": "2006-01-02T15:04:05+00:00", - "ip_exception_list": [ - "192.168.1.0/24", - "1.1.1.1" - ] + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" } } } @@ -10709,11 +10726,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ghes-set-maintenance-response" + "$ref": "#/components/schemas/ghes-delete-ssh-response" }, "examples": { "default": { - "$ref": "#/components/examples/ghes-set-maintenance" + "$ref": "#/components/examples/ghes-delete-ssh" } } } @@ -10738,17 +10755,17 @@ "x-octokit": {} } }, - "/manage/v1/replication/status": { + "/manage/v1/checks/system-requirements": { "get": { - "summary": "Get the status of services running on all replica nodes", - "description": "Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply.", - "operationId": "enterprise-admin/get-replication-status", + "summary": "Get the system requirement check results for configured cluster nodes", + "description": "Checks if the minimum requirements for system hardware resources are met on each configured cluster node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-checks-system-requirements", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-system-requirement-check-results-for-configured-cluster-nodes" }, "servers": [ { @@ -10765,12 +10782,258 @@ } } ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-checks-system-requirements" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-checks-system-requirements" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/cluster/status": { + "get": { + "summary": "Get the status of services running on all cluster nodes", + "description": "Gets the status of all services running on each cluster node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-cluster-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-cluster-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-cluster-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-cluster-status" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/apply": { + "get": { + "summary": "Get the status of a ghe-config-apply run", + "description": "Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID.", + "operationId": "enterprise-admin/get-manage-config-apply-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run" + }, "parameters": [ { - "$ref": "#/components/parameters/uuid" + "name": "run_id", + "description": "The unique run ID of the `ghe-config-apply` run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running in the environment" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful in the environment" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The unique Run ID of the ghe-config-apply run on the host" + }, + "hostname": { + "type": "string", + "description": "The hostname of the node" + }, + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running on the host" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful on the host" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "running": true, + "successful": false, + "nodes": [ + { + "run_id": "d34db33f", + "hostname": "ghes-01.lan", + "running": true, + "successful": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "post": { + "summary": "Trigger a ghe-config-apply run", + "description": "Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.", + "operationId": "enterprise-admin/post-manage-run-config-apply", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run" + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly." + } + } + }, + "examples": { + "default": { + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "servers": [ { - "$ref": "#/components/parameters/cluster-roles" + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } } ], "responses": { @@ -10779,16 +11042,243 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ghes-replication-status" + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "Run ID the job was launched with" + } + } }, "examples": { "default": { - "$ref": "#/components/examples/ghes-replication-status" + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/apply/events": { + "get": { + "summary": "List events from ghe-config-apply", + "description": "Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance.", + "operationId": "enterprise-admin/get-manage-config-apply-events", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#list-events-from-ghe-config-apply" + }, + "parameters": [ + { + "name": "last_request_id", + "description": "The unique ID of the last response from a host, used for pagination.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "Hostname of the node" + }, + "last_request_id": { + "type": "string", + "description": "Unique ID of the last response from a host used for pagination" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "severity_text": { + "type": "string" + }, + "body": { + "type": "string" + }, + "event_name": { + "type": "string" + }, + "topology": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "config_run_id": { + "type": "string" + }, + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "span_parent_id": { + "type": "string" + }, + "span_depth": { + "type": "integer" + } + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "nodes": [ + { + "node": "ghes-01.lan", + "last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000", + "events": [ + { + "timestamp": "2023-01-01T13:00:00+00:00", + "severity_text": "INFO", + "body": "Validating services", + "event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation", + "topology": "multinode", + "hostname": "ghes-01.lan", + "config_run_id": "d34db33f", + "trace_id": "387cd628c06d606700e79be368e5e574", + "span_id": "0cde553750689c76", + "span_parent_id": 0, + "span_depth": 0 + } + ] + } + ] + } } } } } }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/init": { + "post": { + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "operationId": "enterprise-admin/initialize-instance-configuration", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ghes-config-init-request" + }, + "examples": { + "default": { + "value": { + "license": "@enterprise.ghl", + "password": "provide-password-here!" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response" + }, + "400": { + "description": "Bad request" + }, "401": { "description": "Unauthorized" }, @@ -10805,17 +11295,616 @@ "x-octokit": {} } }, - "/manage/v1/version": { + "/manage/v1/config/license": { "get": { - "summary": "Get all GHES release versions for all nodes", - "description": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.11/admin/all-releases).\"", - "operationId": "enterprise-admin/get-version", + "summary": "Get the enterprise license information", + "description": "Gets information about the license that is currently set for the enterprise.", + "operationId": "enterprise-admin/license-info", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-license-info" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-license-info" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "put": { + "summary": "Upload an enterprise license", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "operationId": "enterprise-admin/license-upload", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/license-apply" + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ghes-upload-license-request" + }, + "examples": { + "default": { + "value": { + "license": "@enterprise.ghl" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created" + }, + "202": { + "description": "Accepted" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/license/check": { + "get": { + "summary": "Check a license", + "description": "Check the status of the license that is currently set for the enterprise.", + "operationId": "enterprise-admin/license-check", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#check-a-license" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-license-check" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-license-check" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/nodes": { + "get": { + "summary": "Get GHES node metadata for all nodes", + "description": "Get node metadata for all configured nodes in the current cluster. For more information, see \"[About clustering](https://docs.github.com/enterprise-server@3.13/admin/enterprise-management/configuring-clustering/about-clustering).\"", + "operationId": "enterprise-admin/get-config-nodes", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/uuid" + }, + { + "$ref": "#/components/parameters/cluster-roles" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-config-nodes" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-config-nodes" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/settings": { + "get": { + "summary": "Get the GHES settings", + "description": "Gets a list of settings for a GitHub Enterprise Server instance.", + "operationId": "enterprise-admin/get-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-ghes-settings" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-get-settings" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-get-settings" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set settings", + "description": "Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-settings).\n\n**Notes:**\n- The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values.\n- You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", + "operationId": "enterprise-admin/set-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#set-settings" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "description": "Only the settings parameters that should be modified need to be specified.", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": { + "public_pages": true + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/maintenance": { + "get": { + "summary": "Get the status of maintenance mode", + "description": "Gets the status and details of maintenance mode on all available nodes. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", + "operationId": "enterprise-admin/get-manage-maintenance", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/uuid" + }, + { + "$ref": "#/components/parameters/cluster-roles" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-get-maintenance" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-get-maintenance" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "post": { + "summary": "Set the status of maintenance mode", + "description": "Sets or schedules the maintenance mode. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", + "operationId": "enterprise-admin/set-manage-maintenance", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-maintenance-request" + }, + "examples": { + "default": { + "value": { + "enabled": true, + "when": "2006-01-02T15:04:05+00:00", + "ip_exception_list": [ + "192.168.1.0/24", + "1.1.1.1" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-maintenance-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-set-maintenance" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/replication/status": { + "get": { + "summary": "Get the status of services running on all replica nodes", + "description": "Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-replication-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/uuid" + }, + { + "$ref": "#/components/parameters/cluster-roles" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-replication-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-replication-status" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/version": { + "get": { + "summary": "Get all GHES release versions for all nodes", + "description": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.13/admin/all-releases).\"", + "operationId": "enterprise-admin/get-version", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes" }, "servers": [ { @@ -10882,7 +11971,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/markdown/markdown#render-a-markdown-document" + "url": "https://docs.github.com/enterprise-server@3.13/rest/markdown/markdown#render-a-markdown-document" }, "parameters": [], "requestBody": { @@ -10980,7 +12069,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" + "url": "https://docs.github.com/enterprise-server@3.13/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" }, "parameters": [], "requestBody": { @@ -11058,7 +12147,7 @@ "operationId": "meta/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/meta/meta#get-apiname-meta-information" + "url": "https://docs.github.com/enterprise-server@3.13/rest/meta/meta#get-apiname-meta-information" }, "parameters": [], "responses": { @@ -11093,14 +12182,14 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events-for-repo-network", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-public-events-for-a-network-of-repositories" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-public-events-for-a-network-of-repositories" }, "parameters": [ { @@ -11167,7 +12256,7 @@ "operationId": "activity/list-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -11187,7 +12276,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -11242,14 +12331,14 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#mark-notifications-as-read" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#mark-notifications-as-read" }, "parameters": [], "requestBody": { @@ -11334,7 +12423,7 @@ "operationId": "activity/get-thread", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#get-a-thread" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#get-a-thread" }, "parameters": [ { @@ -11384,7 +12473,7 @@ "operationId": "activity/mark-thread-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#mark-a-thread-as-read" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#mark-a-thread-as-read" }, "parameters": [ { @@ -11409,19 +12498,48 @@ "subcategory": "notifications" }, "x-octokit": {} + }, + "delete": { + "summary": "Mark a thread as done", + "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-thread-as-done", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#mark-a-thread-as-done" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "204": { + "description": "No content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} } }, "/notifications/threads/{thread_id}/subscription": { "get": { "summary": "Get a thread subscription for the authenticated user", - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", "tags": [ "activity" ], "operationId": "activity/get-thread-subscription-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" }, "parameters": [ { @@ -11464,14 +12582,14 @@ }, "put": { "summary": "Set a thread subscription", - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint.", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#delete-a-thread-subscription) endpoint.", "tags": [ "activity" ], "operationId": "activity/set-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#set-a-thread-subscription" }, "parameters": [ { @@ -11538,14 +12656,14 @@ }, "delete": { "summary": "Delete a thread subscription", - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "tags": [ "activity" ], "operationId": "activity/delete-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#delete-a-thread-subscription" }, "parameters": [ { @@ -11613,7 +12731,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/meta/meta#get-octocat" + "url": "https://docs.github.com/enterprise-server@3.13/rest/meta/meta#get-octocat" }, "x-github": { "githubCloudOnly": false, @@ -11627,14 +12745,14 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], "operationId": "orgs/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#list-organizations" }, "parameters": [ { @@ -11686,15 +12804,15 @@ }, "/organizations/{organization_id}/custom_roles": { "get": { - "summary": "Deprecated - List custom repository roles in an organization", - "description": "**Note**: This operation is deprecated and will be removed in the future.\nUse the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Closing down - List custom repository roles in an organization", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#deprecated---list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -11752,14 +12870,14 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.13/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -11796,14 +12914,14 @@ }, "patch": { "summary": "Update an organization", - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -11871,19 +12989,19 @@ }, "members_can_create_internal_repositories": { "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_private_repositories": { "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_public_repositories": { "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_allowed_repository_creation_type": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", "private", @@ -11911,27 +13029,27 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -12009,14 +13127,14 @@ }, "delete": { "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.11/site-policy/github-terms/github-terms-of-service", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.13/site-policy/github-terms/github-terms-of-service", "operationId": "orgs/delete", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { @@ -12053,7 +13171,7 @@ "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -12101,7 +13219,7 @@ "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -12170,7 +13288,7 @@ "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -12210,7 +13328,7 @@ "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -12274,7 +13392,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -12315,7 +13433,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -12375,7 +13493,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12437,7 +13555,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12501,7 +13619,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12533,7 +13651,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12567,7 +13685,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -12608,7 +13726,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -12647,14 +13765,14 @@ "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -12688,14 +13806,14 @@ }, "put": { "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -12744,7 +13862,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" }, "parameters": [ { @@ -12794,7 +13912,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12809,7 +13927,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12915,7 +14033,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12932,7 +14050,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12961,7 +14079,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12976,7 +14094,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -13060,7 +14178,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13075,7 +14193,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" }, "parameters": [ { @@ -13092,7 +14210,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13109,7 +14227,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -13159,7 +14277,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13174,7 +14292,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -13224,7 +14342,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13241,7 +14359,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -13261,7 +14379,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13276,7 +14394,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -13296,7 +14414,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13313,7 +14431,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -13368,7 +14486,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13383,7 +14501,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -13433,7 +14551,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13450,7 +14568,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -13470,7 +14588,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13485,7 +14603,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -13505,7 +14623,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13522,7 +14640,7 @@ "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ { @@ -13599,7 +14717,7 @@ "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -13645,7 +14763,7 @@ "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -13736,7 +14854,7 @@ "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -13779,7 +14897,7 @@ "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -13822,7 +14940,7 @@ "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13866,7 +14984,7 @@ "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -13900,7 +15018,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13935,7 +15053,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -14007,7 +15125,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -14079,7 +15197,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -14116,7 +15234,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -14159,7 +15277,7 @@ "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#list-organization-secrets" }, "parameters": [ { @@ -14228,7 +15346,7 @@ "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -14271,7 +15389,7 @@ "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -14422,7 +15540,7 @@ "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -14456,7 +15574,7 @@ "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -14514,14 +15632,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -14540,7 +15658,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -14579,14 +15697,14 @@ "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -14622,14 +15740,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -14674,7 +15792,7 @@ "operationId": "actions/list-org-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-organization-variables" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#list-organization-variables" }, "parameters": [ { @@ -14741,7 +15859,7 @@ "operationId": "actions/create-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#create-an-organization-variable" }, "parameters": [ { @@ -14838,7 +15956,7 @@ "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { @@ -14882,7 +16000,7 @@ "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -14963,7 +16081,7 @@ "operationId": "actions/delete-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#delete-an-organization-variable" }, "parameters": [ { @@ -14997,7 +16115,7 @@ "operationId": "actions/list-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#list-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -15065,7 +16183,7 @@ "operationId": "actions/set-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#set-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -15133,7 +16251,7 @@ "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -15176,7 +16294,7 @@ "operationId": "actions/remove-selected-repo-from-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#remove-selected-repository-from-an-organization-variable" }, "parameters": [ { @@ -15221,7 +16339,7 @@ "operationId": "announcement-banners/get-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/announcement-banners/organizations#get-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/announcement-banners/organizations#get-announcement-banner-for-organization" }, "parameters": [ { @@ -15262,7 +16380,7 @@ "operationId": "announcement-banners/set-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/announcement-banners/organizations#set-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/announcement-banners/organizations#set-announcement-banner-for-organization" }, "requestBody": { "required": true, @@ -15318,7 +16436,7 @@ "operationId": "announcement-banners/remove-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" }, "parameters": [ { @@ -15342,14 +16460,14 @@ "/orgs/{org}/audit-log": { "get": { "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "operationId": "orgs/get-audit-log", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#get-the-audit-log-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#get-the-audit-log-for-an-organization" }, "parameters": [ { @@ -15409,14 +16527,14 @@ "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -15519,14 +16637,14 @@ "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-repo-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -15573,14 +16691,14 @@ }, "post": { "summary": "Create a custom repository role", - "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#create-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#create-a-custom-repository-role" }, "parameters": [ { @@ -15644,14 +16762,14 @@ "/orgs/{org}/custom-repository-roles/{role_id}": { "get": { "summary": "Get a custom repository role", - "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/get-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#get-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#get-a-custom-repository-role" }, "parameters": [ { @@ -15691,14 +16809,14 @@ }, "patch": { "summary": "Update a custom repository role", - "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#update-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#update-a-custom-repository-role" }, "parameters": [ { @@ -15764,14 +16882,14 @@ }, "delete": { "summary": "Delete a custom repository role", - "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#delete-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#delete-a-custom-repository-role" }, "parameters": [ { @@ -15805,7 +16923,7 @@ "operationId": "dependabot/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" }, "parameters": [ { @@ -15902,7 +17020,7 @@ "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -15971,7 +17089,7 @@ "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -16014,7 +17132,7 @@ "operationId": "dependabot/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#get-an-organization-secret" }, "parameters": [ { @@ -16165,7 +17283,7 @@ "operationId": "dependabot/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -16199,7 +17317,7 @@ "operationId": "dependabot/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -16257,14 +17375,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -16283,7 +17401,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -16322,14 +17440,14 @@ "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -16365,14 +17483,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -16417,7 +17535,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -16462,14 +17580,14 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-public-organization-events" }, "parameters": [ { @@ -16514,14 +17632,14 @@ "/orgs/{org}/external-group/{group_id}": { "get": { "summary": "Get an external group", - "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/external-idp-group-info-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/external-groups#get-an-external-group" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#get-an-external-group" }, "parameters": [ { @@ -16529,6 +17647,12 @@ }, { "$ref": "#/components/parameters/group-id" + }, + { + "$ref": "#/components/parameters/members-per-page" + }, + { + "$ref": "#/components/parameters/members-page" } ], "responses": { @@ -16560,14 +17684,14 @@ "/orgs/{org}/external-groups": { "get": { "summary": "List external groups in an organization", - "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-external-idp-groups-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/external-groups#list-external-groups-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#list-external-groups-in-an-organization" }, "parameters": [ { @@ -16630,14 +17754,14 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#list-organization-webhooks" }, "parameters": [ { @@ -16695,7 +17819,7 @@ "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#create-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#create-an-organization-webhook" }, "parameters": [ { @@ -16744,7 +17868,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "default": [ "push" ], @@ -16832,7 +17956,7 @@ "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#get-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#get-an-organization-webhook" }, "parameters": [ { @@ -16879,7 +18003,7 @@ "operationId": "orgs/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#update-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#update-an-organization-webhook" }, "parameters": [ { @@ -16919,7 +18043,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -16984,14 +18108,14 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#delete-an-organization-webhook" }, "parameters": [ { @@ -17028,7 +18152,7 @@ "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -17072,7 +18196,7 @@ "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -17153,7 +18277,7 @@ "operationId": "orgs/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" }, "parameters": [ { @@ -17167,14 +18291,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -17222,7 +18338,7 @@ "operationId": "orgs/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -17277,7 +18393,7 @@ "operationId": "orgs/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -17313,14 +18429,14 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/webhooks#ping-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/webhooks#ping-an-organization-webhook" }, "parameters": [ { @@ -17350,14 +18466,14 @@ "/orgs/{org}/installation": { "get": { "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-org-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" }, "parameters": [ { @@ -17400,7 +18516,7 @@ "operationId": "orgs/list-app-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-app-installations-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#list-app-installations-for-an-organization" }, "parameters": [ { @@ -17462,14 +18578,14 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -17586,7 +18702,7 @@ "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#list-organization-members" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -17675,7 +18791,7 @@ "operationId": "orgs/check-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#check-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#check-organization-membership-for-a-user" }, "parameters": [ { @@ -17721,7 +18837,7 @@ "operationId": "orgs/remove-member", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#remove-an-organization-member" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#remove-an-organization-member" }, "parameters": [ { @@ -17758,7 +18874,7 @@ "operationId": "orgs/get-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#get-organization-membership-for-a-user" }, "parameters": [ { @@ -17801,14 +18917,14 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.13/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], "operationId": "orgs/set-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#set-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#set-organization-membership-for-a-user" }, "parameters": [ { @@ -17887,7 +19003,7 @@ "operationId": "orgs/remove-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#remove-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#remove-organization-membership-for-a-user" }, "parameters": [ { @@ -17927,7 +19043,7 @@ "operationId": "migrations/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/orgs#list-organization-migrations" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/orgs#list-organization-migrations" }, "parameters": [ { @@ -17991,14 +19107,14 @@ }, "post": { "summary": "Start an organization migration", - "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.11/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).\"", + "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.13/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" ], "operationId": "migrations/start-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/orgs#start-an-organization-migration" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/orgs#start-an-organization-migration" }, "parameters": [ { @@ -18129,7 +19245,7 @@ "operationId": "migrations/get-status-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/orgs#get-an-organization-migration-status" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/orgs#get-an-organization-migration-status" }, "parameters": [ { @@ -18194,7 +19310,7 @@ "operationId": "migrations/download-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/orgs#download-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/orgs#download-an-organization-migration-archive" }, "parameters": [ { @@ -18229,7 +19345,7 @@ "operationId": "migrations/delete-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/orgs#delete-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/orgs#delete-an-organization-migration-archive" }, "parameters": [ { @@ -18259,14 +19375,14 @@ "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { "delete": { "summary": "Unlock an organization repository", - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", "tags": [ "migrations" ], "operationId": "migrations/unlock-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/orgs#unlock-an-organization-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/orgs#unlock-an-organization-repository" }, "parameters": [ { @@ -18306,7 +19422,7 @@ "operationId": "migrations/list-repos-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/orgs#list-repositories-in-an-organization-migration" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/orgs#list-repositories-in-an-organization-migration" }, "parameters": [ { @@ -18369,7 +19485,7 @@ "operationId": "orgs/list-outside-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" }, "parameters": [ { @@ -18433,14 +19549,14 @@ "/orgs/{org}/outside_collaborators/{username}": { "put": { "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.11/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.13/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "tags": [ "orgs" ], "operationId": "orgs/convert-member-to-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" }, "parameters": [ { @@ -18501,7 +19617,7 @@ "description": "User was converted" }, "403": { - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" }, "404": { "$ref": "#/components/responses/not_found" @@ -18524,7 +19640,7 @@ "operationId": "orgs/remove-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" }, "parameters": [ { @@ -18557,7 +19673,7 @@ "response-if-user-is-a-member-of-the-organization": { "value": { "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "documentation_url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" } } } @@ -18577,14 +19693,14 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#list-packages-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#list-packages-for-an-organization" }, "parameters": [ { @@ -18612,7 +19728,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -18621,7 +19737,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -18670,14 +19786,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-a-package-for-an-organization" }, "parameters": [ { @@ -18717,14 +19833,14 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#delete-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#delete-a-package-for-an-organization" }, "parameters": [ { @@ -18763,14 +19879,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#restore-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#restore-a-package-for-an-organization" }, "parameters": [ { @@ -18818,14 +19934,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ { @@ -18909,14 +20025,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-a-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-a-package-version-for-an-organization" }, "parameters": [ { @@ -18959,14 +20075,14 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#delete-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#delete-package-version-for-an-organization" }, "parameters": [ { @@ -19008,14 +20124,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#restore-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#restore-package-version-for-an-organization" }, "parameters": [ { @@ -19064,7 +20180,7 @@ "operationId": "orgs/list-pat-grant-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -19152,7 +20268,7 @@ "operationId": "orgs/review-pat-grant-requests-in-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -19246,7 +20362,7 @@ "operationId": "orgs/review-pat-grant-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -19336,7 +20452,7 @@ "operationId": "orgs/list-pat-grant-request-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -19411,7 +20527,7 @@ "operationId": "orgs/list-pat-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" }, "parameters": [ { @@ -19499,7 +20615,7 @@ "operationId": "orgs/update-pat-accesses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -19587,7 +20703,7 @@ "operationId": "orgs/update-pat-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" }, "parameters": [ { @@ -19663,7 +20779,7 @@ "operationId": "orgs/list-pat-grant-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" }, "parameters": [ { @@ -19738,7 +20854,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization" }, "parameters": [ { @@ -19808,7 +20924,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization" }, "parameters": [ { @@ -19852,7 +20968,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization" }, "parameters": [ { @@ -19924,7 +21040,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization" }, "parameters": [ { @@ -19970,7 +21086,7 @@ "operationId": "projects/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#list-organization-projects" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#list-organization-projects" }, "parameters": [ { @@ -20043,7 +21159,7 @@ "operationId": "projects/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#create-an-organization-project" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#create-an-organization-project" }, "parameters": [ { @@ -20122,6 +21238,472 @@ "x-octokit": {} } }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-all-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-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/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-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/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" + ], + "values_editable_by": "org_actors" + }, + { + "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/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-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/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-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": { + "$ref": "#/components/schemas/custom-property-set-payload" + }, + "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/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-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": "custom-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-server@3.13/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "repository_query", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.13/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "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": "custom-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\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-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": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + }, + "x-octokit": {} + } + }, "/orgs/{org}/public_members": { "get": { "summary": "List public organization members", @@ -20132,7 +21714,7 @@ "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#list-public-organization-members" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#list-public-organization-members" }, "parameters": [ { @@ -20189,7 +21771,7 @@ "operationId": "orgs/check-public-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#check-public-organization-membership-for-a-user" }, "parameters": [ { @@ -20217,14 +21799,14 @@ }, "put": { "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "orgs" ], "operationId": "orgs/set-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -20259,7 +21841,7 @@ "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -20286,14 +21868,14 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-organization-repositories" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-organization-repositories" }, "parameters": [ { @@ -20395,7 +21977,7 @@ "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-an-organization-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-an-organization-repository" }, "parameters": [ { @@ -20428,7 +22010,7 @@ }, "visibility": { "type": "string", - "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.11/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.13/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -20476,7 +22058,7 @@ }, "license_template": { "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.11/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.13/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." }, "allow_squash_merge": { "type": "boolean", @@ -20505,7 +22087,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -20515,7 +22097,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -20532,7 +22114,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -20612,14 +22194,14 @@ "/orgs/{org}/repository-fine-grained-permissions": { "get": { "summary": "List repository fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-repo-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -20665,7 +22247,7 @@ "operationId": "repos/get-org-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/rules#get-all-organization-repository-rulesets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/rules#get-all-organization-repository-rulesets" }, "x-github": { "githubCloudOnly": false, @@ -20682,6 +22264,9 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -20721,7 +22306,7 @@ "operationId": "repos/create-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/rules#create-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/rules#create-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -20751,8 +22336,10 @@ "description": "The target of the ruleset.", "enum": [ "branch", - "tag" - ] + "tag", + "push" + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -20773,6 +22360,14 @@ "items": { "$ref": "#/components/schemas/repository-rule" } + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] } }, "required": [ @@ -20855,17 +22450,139 @@ "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-server@3.13/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-server@3.13/rest/orgs/rule-suites#list-organization-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/ref-in-query" + }, + { + "$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-server@3.13/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-server@3.13/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", - "description": "Get a repository ruleset for an organization.", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], "operationId": "repos/get-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/rules#get-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/rules#get-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -20921,7 +22638,7 @@ "operationId": "repos/update-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/rules#update-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/rules#update-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -20960,7 +22677,8 @@ "description": "The target of the ruleset.", "enum": [ "branch", - "tag" + "tag", + "push" ] }, "enforcement": { @@ -21068,7 +22786,7 @@ "operationId": "repos/delete-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/rules#delete-an-organization-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/rules#delete-an-organization-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -21114,7 +22832,7 @@ "operationId": "secret-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -21146,6 +22864,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -21191,14 +22912,14 @@ "/orgs/{org}/security-managers": { "get": { "summary": "List security manager teams", - "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-security-manager-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/security-managers#list-security-manager-teams" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/security-managers#list-security-manager-teams" }, "parameters": [ { @@ -21238,14 +22959,14 @@ "/orgs/{org}/security-managers/teams/{team_slug}": { "put": { "summary": "Add a security manager team", - "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/add-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/security-managers#add-a-security-manager-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/security-managers#add-a-security-manager-team" }, "parameters": [ { @@ -21274,14 +22995,14 @@ }, "delete": { "summary": "Remove a security manager team", - "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/remove-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/security-managers#remove-a-security-manager-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/security-managers#remove-a-security-manager-team" }, "parameters": [ { @@ -21316,7 +23037,7 @@ "operationId": "billing/get-github-advanced-security-billing-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" }, "parameters": [ { @@ -21344,9 +23065,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -21368,7 +23086,7 @@ "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-teams" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-teams" }, "parameters": [ { @@ -21419,14 +23137,14 @@ }, "post": { "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.11/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.13/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#create-a-team" }, "parameters": [ { @@ -21480,7 +23198,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push" @@ -21493,7 +23211,7 @@ }, "ldap_dn": { "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"" + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"" } }, "required": [ @@ -21549,14 +23267,14 @@ "/orgs/{org}/teams/{team_slug}": { "get": { "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#get-a-team-by-name" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#get-a-team-by-name" }, "parameters": [ { @@ -21596,14 +23314,14 @@ }, "patch": { "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#update-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#update-a-team" }, "parameters": [ { @@ -21646,7 +23364,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -21725,14 +23443,14 @@ }, "delete": { "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/delete-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#delete-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#delete-a-team" }, "parameters": [ { @@ -21759,14 +23477,14 @@ "/orgs/{org}/teams/{team_slug}/discussions": { "get": { "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#list-discussions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions" }, "parameters": [ { @@ -21829,14 +23547,14 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#create-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion" }, "parameters": [ { @@ -21913,14 +23631,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion" }, "parameters": [ { @@ -21960,14 +23678,14 @@ }, "patch": { "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#update-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#update-a-discussion" }, "parameters": [ { @@ -22034,14 +23752,14 @@ }, "delete": { "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#delete-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion" }, "parameters": [ { @@ -22071,14 +23789,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussion-comments-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#list-discussion-comments" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments" }, "parameters": [ { @@ -22135,14 +23853,14 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#create-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment" }, "parameters": [ { @@ -22211,14 +23929,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment" }, "parameters": [ { @@ -22261,14 +23979,14 @@ }, "patch": { "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#update-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment" }, "parameters": [ { @@ -22337,14 +24055,14 @@ }, "delete": { "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#delete-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment" }, "parameters": [ { @@ -22377,14 +24095,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" }, "parameters": [ { @@ -22401,7 +24119,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", "required": false, "schema": { @@ -22460,14 +24178,14 @@ }, "post": { "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" }, "parameters": [ { @@ -22492,7 +24210,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "enum": [ "+1", "-1", @@ -22563,14 +24281,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/delete-for-team-discussion-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-team-discussion-comment-reaction" }, "parameters": [ { @@ -22606,14 +24324,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion" }, "parameters": [ { @@ -22627,7 +24345,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "query", "required": false, "schema": { @@ -22686,14 +24404,14 @@ }, "post": { "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion" }, "parameters": [ { @@ -22715,7 +24433,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ "+1", "-1", @@ -22786,14 +24504,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/delete-for-team-discussion", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-team-discussion-reaction" }, "parameters": [ { @@ -22826,14 +24544,14 @@ "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -22870,14 +24588,14 @@ }, "patch": { "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/link-external-idp-group-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -22941,14 +24659,14 @@ }, "delete": { "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/unlink-external-idp-group-from-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -22982,7 +24700,7 @@ "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#list-team-members" }, "parameters": [ { @@ -23050,14 +24768,14 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user" }, "parameters": [ { @@ -23100,14 +24818,14 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -23182,14 +24900,14 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -23222,14 +24940,14 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "tags": [ "teams" ], "operationId": "teams/list-projects-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects" }, "parameters": [ { @@ -23282,14 +25000,14 @@ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-project" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-project" }, "parameters": [ { @@ -23332,14 +25050,14 @@ }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-project-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions" }, "parameters": [ { @@ -23361,7 +25079,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "enum": [ "read", "write", @@ -23405,7 +25123,7 @@ "response-if-the-project-is-not-owned-by-the-organization": { "value": { "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions" + "documentation_url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions" } } } @@ -23423,14 +25141,14 @@ }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/remove-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-project-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-project-from-a-team" }, "parameters": [ { @@ -23460,14 +25178,14 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -23520,14 +25238,14 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -23576,14 +25294,14 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-repository-permissions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -23608,8 +25326,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "default": "push" + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." } } }, @@ -23639,14 +25356,14 @@ }, "delete": { "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-repository-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -23679,14 +25396,14 @@ "/orgs/{org}/teams/{team_slug}/teams": { "get": { "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -23739,14 +25456,14 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -23811,7 +25528,7 @@ "operationId": "projects/get-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/cards#get-a-project-card" }, "parameters": [ { @@ -23864,7 +25581,7 @@ "operationId": "projects/update-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/cards#update-an-existing-project-card" }, "parameters": [ { @@ -23951,7 +25668,7 @@ "operationId": "projects/delete-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/cards#delete-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/cards#delete-a-project-card" }, "parameters": [ { @@ -24015,7 +25732,7 @@ "operationId": "projects/move-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/cards#move-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/cards#move-a-project-card" }, "parameters": [ { @@ -24177,7 +25894,7 @@ "operationId": "projects/get-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/columns#get-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/columns#get-a-project-column" }, "parameters": [ { @@ -24230,7 +25947,7 @@ "operationId": "projects/update-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/columns#update-an-existing-project-column" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/columns#update-an-existing-project-column" }, "parameters": [ { @@ -24308,7 +26025,7 @@ "operationId": "projects/delete-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/columns#delete-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/columns#delete-a-project-column" }, "parameters": [ { @@ -24348,7 +26065,7 @@ "operationId": "projects/list-cards", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/cards#list-project-cards" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/cards#list-project-cards" }, "parameters": [ { @@ -24427,7 +26144,7 @@ "operationId": "projects/create-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/cards#create-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/cards#create-a-project-card" }, "parameters": [ { @@ -24583,7 +26300,7 @@ "operationId": "projects/move-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/columns#move-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/columns#move-a-project-column" }, "parameters": [ { @@ -24669,7 +26386,7 @@ "operationId": "projects/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#get-a-project" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#get-a-project" }, "parameters": [ { @@ -24719,7 +26436,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#update-a-project" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#update-a-project" }, "parameters": [ { @@ -24851,7 +26568,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#delete-a-project" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#delete-a-project" }, "parameters": [ { @@ -24918,7 +26635,7 @@ "operationId": "projects/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/collaborators#list-project-collaborators" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#list-project-collaborators" }, "parameters": [ { @@ -25005,7 +26722,7 @@ "operationId": "projects/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/collaborators#add-project-collaborator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#add-project-collaborator" }, "parameters": [ { @@ -25084,7 +26801,7 @@ "operationId": "projects/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/collaborators#remove-user-as-a-collaborator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#remove-user-as-a-collaborator" }, "parameters": [ { @@ -25133,7 +26850,7 @@ "operationId": "projects/get-permission-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/collaborators#get-project-permission-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#get-project-permission-for-a-user" }, "parameters": [ { @@ -25194,7 +26911,7 @@ "operationId": "projects/list-columns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/columns#list-project-columns" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/columns#list-project-columns" }, "parameters": [ { @@ -25258,7 +26975,7 @@ "operationId": "projects/create-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/columns#create-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/columns#create-a-project-column" }, "parameters": [ { @@ -25342,14 +27059,14 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.11/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.11/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.11/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.11/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.11/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, "parameters": [], "responses": { @@ -25398,14 +27115,14 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#get-a-repository" }, "parameters": [ { @@ -25451,14 +27168,14 @@ }, "patch": { "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#replace-all-repository-topics) endpoint.", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#replace-all-repository-topics) endpoint.", "tags": [ "repos" ], "operationId": "repos/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#update-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#update-a-repository" }, "parameters": [ { @@ -25489,7 +27206,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.13/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -25503,7 +27220,7 @@ }, "security_and_analysis": { "type": "object", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "nullable": true, "properties": { "advanced_security": { @@ -25589,7 +27306,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -25599,7 +27316,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -25616,7 +27333,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -25698,12 +27415,12 @@ { "required": false, "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.11/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.13/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" }, { "required": false, "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -25718,7 +27435,7 @@ "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#delete-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#delete-a-repository" }, "parameters": [ { @@ -25754,7 +27471,7 @@ "default": { "value": { "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#delete-a-repository" + "documentation_url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#delete-a-repository" } } } @@ -25784,7 +27501,7 @@ "operationId": "actions/list-artifacts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/artifacts#list-artifacts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/artifacts#list-artifacts-for-a-repository" }, "parameters": [ { @@ -25859,7 +27576,7 @@ "operationId": "actions/get-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/artifacts#get-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/artifacts#get-an-artifact" }, "parameters": [ { @@ -25906,7 +27623,7 @@ "operationId": "actions/delete-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/artifacts#delete-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/artifacts#delete-an-artifact" }, "parameters": [ { @@ -25943,7 +27660,7 @@ "operationId": "actions/download-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/artifacts#download-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/artifacts#download-an-artifact" }, "parameters": [ { @@ -25996,7 +27713,7 @@ "operationId": "actions/get-actions-cache-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" }, "parameters": [ { @@ -26042,7 +27759,7 @@ "operationId": "actions/get-actions-cache-usage-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository" }, "parameters": [ { @@ -26086,7 +27803,7 @@ "operationId": "actions/set-actions-cache-usage-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository" }, "parameters": [ { @@ -26135,7 +27852,7 @@ "operationId": "actions/get-actions-cache-list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#list-github-actions-caches-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#list-github-actions-caches-for-a-repository" }, "parameters": [ { @@ -26203,7 +27920,7 @@ "operationId": "actions/delete-actions-cache-by-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" }, "parameters": [ { @@ -26255,7 +27972,7 @@ "operationId": "actions/delete-actions-cache-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" }, "parameters": [ { @@ -26292,7 +28009,7 @@ "operationId": "actions/get-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" }, "parameters": [ { @@ -26341,7 +28058,7 @@ "operationId": "actions/download-job-logs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" }, "parameters": [ { @@ -26386,7 +28103,7 @@ "operationId": "actions/re-run-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" }, "parameters": [ { @@ -26461,7 +28178,7 @@ "operationId": "actions/get-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -26511,7 +28228,7 @@ "operationId": "actions/set-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -26605,7 +28322,7 @@ "operationId": "actions/list-repo-organization-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-repository-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#list-repository-organization-secrets" }, "parameters": [ { @@ -26677,7 +28394,7 @@ "operationId": "actions/list-repo-organization-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-repository-organization-variables" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#list-repository-organization-variables" }, "parameters": [ { @@ -26749,7 +28466,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -26803,7 +28520,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -26859,14 +28576,14 @@ "/repos/{owner}/{repo}/actions/permissions/access": { "get": { "summary": "Get the level of access for workflows outside of the repository", - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -26904,14 +28621,14 @@ }, "put": { "summary": "Set the level of access for workflows outside of the repository", - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -26961,7 +28678,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -27005,7 +28722,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -27047,14 +28764,14 @@ "/repos/{owner}/{repo}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for a repository", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -27091,14 +28808,14 @@ }, "put": { "summary": "Set default workflow permissions for a repository", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -27150,7 +28867,7 @@ "operationId": "actions/list-self-hosted-runners-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" }, "parameters": [ { @@ -27230,7 +28947,7 @@ "operationId": "actions/list-runner-applications-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" }, "parameters": [ { @@ -27279,7 +28996,7 @@ "operationId": "actions/generate-runner-jitconfig-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" }, "parameters": [ { @@ -27373,7 +29090,7 @@ "operationId": "actions/create-registration-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" }, "parameters": [ { @@ -27419,7 +29136,7 @@ "operationId": "actions/create-remove-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" }, "parameters": [ { @@ -27465,7 +29182,7 @@ "operationId": "actions/get-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27512,7 +29229,7 @@ "operationId": "actions/delete-self-hosted-runner-from-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" }, "parameters": [ { @@ -27549,7 +29266,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27587,7 +29304,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27662,7 +29379,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27737,7 +29454,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27777,7 +29494,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27816,14 +29533,14 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" }, "parameters": [ { @@ -27919,7 +29636,7 @@ "operationId": "actions/get-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#get-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#get-a-workflow-run" }, "parameters": [ { @@ -27969,7 +29686,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#delete-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#delete-a-workflow-run" }, "parameters": [ { @@ -28006,7 +29723,7 @@ "operationId": "actions/get-reviews-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" }, "parameters": [ { @@ -28058,7 +29775,7 @@ "operationId": "actions/list-workflow-run-artifacts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/artifacts#list-workflow-run-artifacts" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/artifacts#list-workflow-run-artifacts" }, "parameters": [ { @@ -28136,7 +29853,7 @@ "operationId": "actions/get-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#get-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#get-a-workflow-run-attempt" }, "parameters": [ { @@ -28184,14 +29901,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { "get": { "summary": "List jobs for a workflow run attempt", - "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" }, "parameters": [ { @@ -28272,7 +29989,7 @@ "operationId": "actions/download-workflow-run-attempt-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#download-workflow-run-attempt-logs" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#download-workflow-run-attempt-logs" }, "parameters": [ { @@ -28320,7 +30037,7 @@ "operationId": "actions/cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#cancel-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#cancel-a-workflow-run" }, "parameters": [ { @@ -28365,14 +30082,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/review-custom-gates-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" }, "parameters": [ { @@ -28426,17 +30143,69 @@ "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\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/force-cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/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", - "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" }, "parameters": [ { @@ -28525,7 +30294,7 @@ "operationId": "actions/download-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#download-workflow-run-logs" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#download-workflow-run-logs" }, "parameters": [ { @@ -28568,7 +30337,7 @@ "operationId": "actions/delete-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#delete-workflow-run-logs" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#delete-workflow-run-logs" }, "parameters": [ { @@ -28611,7 +30380,7 @@ "operationId": "actions/get-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -28661,7 +30430,7 @@ "operationId": "actions/review-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -28767,7 +30536,7 @@ "operationId": "actions/re-run-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#re-run-a-workflow" }, "parameters": [ { @@ -28839,7 +30608,7 @@ "operationId": "actions/re-run-workflow-failed-jobs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" }, "parameters": [ { @@ -28911,7 +30680,7 @@ "operationId": "actions/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#list-repository-secrets" }, "parameters": [ { @@ -28983,7 +30752,7 @@ "operationId": "actions/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -29029,7 +30798,7 @@ "operationId": "actions/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-a-repository-secret" }, "parameters": [ { @@ -29069,14 +30838,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -29098,7 +30867,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -29155,7 +30924,7 @@ "operationId": "actions/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -29192,7 +30961,7 @@ "operationId": "actions/list-repo-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-repository-variables" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#list-repository-variables" }, "parameters": [ { @@ -29262,7 +31031,7 @@ "operationId": "actions/create-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#create-a-repository-variable" }, "parameters": [ { @@ -29340,7 +31109,7 @@ "operationId": "actions/get-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#get-a-repository-variable" }, "parameters": [ { @@ -29387,7 +31156,7 @@ "operationId": "actions/update-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#update-a-repository-variable" }, "parameters": [ { @@ -29450,7 +31219,7 @@ "operationId": "actions/delete-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#delete-a-repository-variable" }, "parameters": [ { @@ -29487,7 +31256,7 @@ "operationId": "actions/list-repo-workflows", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflows#list-repository-workflows" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflows#list-repository-workflows" }, "parameters": [ { @@ -29559,7 +31328,7 @@ "operationId": "actions/get-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflows#get-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflows#get-a-workflow" }, "parameters": [ { @@ -29608,7 +31377,7 @@ "operationId": "actions/disable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflows#disable-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflows#disable-a-workflow" }, "parameters": [ { @@ -29645,7 +31414,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflows#create-a-workflow-dispatch-event" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflows#create-a-workflow-dispatch-event" }, "parameters": [ { @@ -29718,7 +31487,7 @@ "operationId": "actions/enable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflows#enable-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflows#enable-a-workflow" }, "parameters": [ { @@ -29748,14 +31517,14 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs for a workflow", - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" }, "parameters": [ { @@ -29847,14 +31616,14 @@ "/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 activity and data for your repository](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository).\"", + "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-server@3.13/repositories/viewing-activity-and-data-for-your-repository).\"", "tags": [ "repos" ], "operationId": "repos/list-activities", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-activities" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-activities" }, "parameters": [ { @@ -29967,14 +31736,14 @@ "/repos/{owner}/{repo}/assignees": { "get": { "summary": "List assignees", - "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.11/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.13/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "tags": [ "issues" ], "operationId": "issues/list-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/assignees#list-assignees" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/assignees#list-assignees" }, "parameters": [ { @@ -30037,7 +31806,7 @@ "operationId": "issues/check-user-can-be-assigned", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/assignees#check-if-a-user-can-be-assigned" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/assignees#check-if-a-user-can-be-assigned" }, "parameters": [ { @@ -30089,7 +31858,7 @@ "operationId": "repos/list-autolinks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/autolinks#get-all-autolinks-of-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/autolinks#get-all-autolinks-of-a-repository" }, "parameters": [ { @@ -30136,7 +31905,7 @@ "operationId": "repos/create-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" }, "parameters": [ { @@ -30231,7 +32000,7 @@ "operationId": "repos/get-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" }, "parameters": [ { @@ -30281,7 +32050,7 @@ "operationId": "repos/delete-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" }, "parameters": [ { @@ -30314,14 +32083,14 @@ "/repos/{owner}/{repo}/automated-security-fixes": { "get": { "summary": "Check if automated security fixes are enabled for a repository", - "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.11/articles/configuring-automated-security-fixes)\".", + "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.13/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/check-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository" }, "parameters": [ { @@ -30333,7 +32102,7 @@ ], "responses": { "200": { - "description": "Response if dependabot is enabled", + "description": "Response if Dependabot is enabled", "content": { "application/json": { "schema": { @@ -30351,7 +32120,7 @@ } }, "404": { - "description": "Not Found if dependabot is not enabled for the repository" + "description": "Not Found if Dependabot is not enabled for the repository" } }, "x-github": { @@ -30373,7 +32142,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branches#list-branches" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branches#list-branches" }, "parameters": [ { @@ -30384,7 +32153,7 @@ }, { "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "description": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", "required": false, "schema": { @@ -30445,7 +32214,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branches#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -30493,14 +32262,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection": { "get": { "summary": "Get branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -30543,14 +32312,14 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -30582,7 +32351,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -30656,7 +32425,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.11/articles/about-code-owners/) review them." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.13/articles/about-code-owners/) review them." }, "required_approving_review_count": { "type": "integer", @@ -30730,16 +32499,16 @@ }, "required_linear_history": { "type": "boolean", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." }, "allow_force_pushes": { "type": "boolean", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "nullable": true }, "allow_deletions": { "type": "boolean", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." }, "block_creations": { "type": "boolean", @@ -30859,14 +32628,14 @@ }, "delete": { "summary": "Delete branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -30899,14 +32668,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { "get": { "summary": "Get admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -30946,14 +32715,14 @@ }, "post": { "summary": "Set admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -30993,14 +32762,14 @@ }, "delete": { "summary": "Delete admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -31033,14 +32802,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { "get": { "summary": "Get pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -31080,14 +32849,14 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -31140,7 +32909,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.11/articles/about-code-owners/) have reviewed." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.13/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { "type": "integer", @@ -31245,14 +33014,14 @@ }, "delete": { "summary": "Delete pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -31285,14 +33054,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.11/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.13/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -31335,14 +33104,14 @@ }, "post": { "summary": "Create commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -31385,14 +33154,14 @@ }, "delete": { "summary": "Delete commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -31425,14 +33194,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { "get": { "summary": "Get status checks protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -31475,14 +33244,14 @@ }, "patch": { "summary": "Update status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -31509,7 +33278,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -31592,14 +33361,14 @@ }, "delete": { "summary": "Remove status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -31629,14 +33398,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { "get": { "summary": "Get all status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -31684,14 +33453,14 @@ }, "post": { "summary": "Add status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -31789,14 +33558,14 @@ }, "put": { "summary": "Set status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -31889,14 +33658,14 @@ }, "delete": { "summary": "Remove status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -31990,14 +33759,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -32040,14 +33809,14 @@ }, "delete": { "summary": "Delete access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "tags": [ "repos" ], "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -32077,14 +33846,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { "get": { "summary": "Get apps with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -32130,14 +33899,14 @@ }, "post": { "summary": "Add app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -32151,126 +33920,118 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] - }, - "examples": { - "default": { - "value": { - "apps": [ - "octoapp" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/integration" - } }, - "examples": { - "default": { - "$ref": "#/components/examples/integration-items" - } + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "apps", + "category": "branches", + "subcategory": "branch-protection" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "tags": [ + "repos" + ], + "operationId": "repos/set-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#set-app-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] } - } - } - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "requestBodyParameterName": "apps", - "category": "branches", - "subcategory": "branch-protection" - }, - "x-octokit": {} - }, - "put": { - "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", - "tags": [ - "repos" - ], - "operationId": "repos/set-app-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#set-app-access-restrictions" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/branch" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] - } - } - ] }, "examples": { "default": { @@ -32318,14 +34079,14 @@ }, "delete": { "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -32339,31 +34100,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -32413,14 +34171,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { "get": { "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -32466,14 +34224,14 @@ }, "post": { "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", "tags": [ "repos" ], "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -32561,14 +34319,14 @@ }, "put": { "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", "tags": [ "repos" ], "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -32656,14 +34414,14 @@ }, "delete": { "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", "tags": [ "repos" ], "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -32752,14 +34510,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { "get": { "summary": "Get users with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "tags": [ "repos" ], "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -32805,14 +34563,14 @@ }, "post": { "summary": "Add user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -32826,32 +34584,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -32900,14 +34654,14 @@ }, "put": { "summary": "Set user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -32921,32 +34675,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -32995,14 +34745,14 @@ }, "delete": { "summary": "Remove user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -33016,31 +34766,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -33091,14 +34838,14 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branches#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -33493,14 +35240,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}": { "get": { "summary": "Get a check run", - "description": "Gets a single check run using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/runs#get-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/runs#get-a-check-run" }, "parameters": [ { @@ -33540,14 +35287,14 @@ }, "patch": { "summary": "Update a check run", - "description": "Updates a check run for a specific commit in a 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/runs#update-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/runs#update-a-check-run" }, "parameters": [ { @@ -33635,7 +35382,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.11/articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.13/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.13/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -33723,7 +35470,7 @@ }, "actions": { "type": "array", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.11/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.13/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -33860,7 +35607,7 @@ "operationId": "checks/list-annotations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/runs#list-check-run-annotations" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/runs#list-check-run-annotations" }, "parameters": [ { @@ -33916,14 +35663,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/rerequest-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/runs#rerequest-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/runs#rerequest-a-check-run" }, "parameters": [ { @@ -33988,14 +35735,14 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.13/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/create-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/suites#create-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/suites#create-a-check-suite" }, "parameters": [ { @@ -34075,14 +35822,14 @@ "/repos/{owner}/{repo}/check-suites/preferences": { "patch": { "summary": "Update repository preferences for check suites", - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", "tags": [ "checks" ], "operationId": "checks/set-suites-preferences", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/suites#update-repository-preferences-for-check-suites" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/suites#update-repository-preferences-for-check-suites" }, "parameters": [ { @@ -34167,14 +35914,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { "get": { "summary": "Get a check suite", - "description": "Gets a single check suite using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/get-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/suites#get-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/suites#get-a-check-suite" }, "parameters": [ { @@ -34216,14 +35963,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "Lists check runs for a check suite using its `id`.\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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/runs#list-check-runs-in-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/runs#list-check-runs-in-a-check-suite" }, "parameters": [ { @@ -34311,14 +36058,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { "post": { "summary": "Rerequest a check suite", - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/suites#rerequest-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/suites#rerequest-a-check-suite" }, "parameters": [ { @@ -34367,7 +36114,7 @@ "operationId": "code-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -34478,7 +36225,7 @@ "operationId": "code-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#get-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#get-a-code-scanning-alert" }, "parameters": [ { @@ -34548,7 +36295,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#update-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#update-a-code-scanning-alert" }, "parameters": [ { @@ -34639,7 +36386,7 @@ "operationId": "code-scanning/list-alert-instances", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" }, "parameters": [ { @@ -34712,14 +36459,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses": { "get": { "summary": "List code scanning analyses for a repository", - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/list-recent-analyses", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" }, "parameters": [ { @@ -34816,14 +36563,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" }, "parameters": [ { @@ -34896,7 +36643,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" }, "parameters": [ { @@ -34973,7 +36720,7 @@ "operationId": "code-scanning/get-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -35026,7 +36773,7 @@ "operationId": "code-scanning/update-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -35107,14 +36854,14 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" }, "parameters": [ { @@ -35226,7 +36973,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" + "url": "https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" }, "parameters": [ { @@ -35283,14 +37030,14 @@ "/repos/{owner}/{repo}/codeowners/errors": { "get": { "summary": "List CODEOWNERS errors", - "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", + "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", "tags": [ "repos" ], "operationId": "repos/codeowners-errors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-codeowners-errors" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-codeowners-errors" }, "parameters": [ { @@ -35349,7 +37096,7 @@ "operationId": "repos/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators#list-repository-collaborators" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators#list-repository-collaborators" }, "parameters": [ { @@ -35443,7 +37190,7 @@ "operationId": "repos/check-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" }, "parameters": [ { @@ -35474,14 +37221,14 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", + "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", "tags": [ "repos" ], "operationId": "repos/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators#add-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators#add-a-repository-collaborator" }, "parameters": [ { @@ -35541,14 +37288,14 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n**Note**: A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], "operationId": "repos/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators#remove-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators#remove-a-repository-collaborator" }, "parameters": [ { @@ -35591,7 +37338,7 @@ "operationId": "repos/get-collaborator-permission-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators#get-repository-permissions-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators#get-repository-permissions-for-a-user" }, "parameters": [ { @@ -35636,14 +37383,14 @@ "/repos/{owner}/{repo}/comments": { "get": { "summary": "List commit comments for a repository", - "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-commit-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/comments#list-commit-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/comments#list-commit-comments-for-a-repository" }, "parameters": [ { @@ -35696,14 +37443,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}": { "get": { "summary": "Get a commit comment", - "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/get-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment" }, "parameters": [ { @@ -35746,14 +37493,14 @@ }, "patch": { "summary": "Update a commit comment", - "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/update-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/comments#update-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/comments#update-a-commit-comment" }, "parameters": [ { @@ -35829,7 +37576,7 @@ "operationId": "repos/delete-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/comments#delete-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/comments#delete-a-commit-comment" }, "parameters": [ { @@ -35862,14 +37609,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a commit comment", - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment).", + "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-commit-comment" }, "parameters": [ { @@ -35883,7 +37630,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", "in": "query", "required": false, "schema": { @@ -35945,14 +37692,14 @@ }, "post": { "summary": "Create reaction for a commit comment", - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", + "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-commit-comment" }, "parameters": [ { @@ -35974,7 +37721,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the commit comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the commit comment.", "enum": [ "+1", "-1", @@ -36048,14 +37795,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#delete-a-commit-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-a-commit-comment-reaction" }, "parameters": [ { @@ -36088,14 +37835,14 @@ "/repos/{owner}/{repo}/commits": { "get": { "summary": "List commits", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits" }, "parameters": [ { @@ -36141,11 +37888,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -36209,14 +37963,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { "get": { "summary": "List branches for HEAD commit", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "tags": [ "repos" ], "operationId": "repos/list-branches-for-head-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-branches-for-head-commit" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-branches-for-head-commit" }, "parameters": [ { @@ -36267,14 +38021,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { "get": { "summary": "List commit comments", - "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-comments-for-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/comments#list-commit-comments" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/comments#list-commit-comments" }, "parameters": [ { @@ -36328,14 +38082,14 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/create-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/comments#create-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/comments#create-a-commit-comment" }, "parameters": [ { @@ -36369,7 +38123,7 @@ }, "line": { "type": "integer", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." + "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ @@ -36440,7 +38194,7 @@ "operationId": "repos/list-pull-requests-associated-with-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-pull-requests-associated-with-a-commit" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-pull-requests-associated-with-a-commit" }, "parameters": [ { @@ -36499,14 +38253,14 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/commits#get-a-commit" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/commits#get-a-commit" }, "parameters": [ { @@ -36569,14 +38323,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\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.11/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.11/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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.13/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.13/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/runs#list-check-runs-for-a-git-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/runs#list-check-runs-for-a-git-reference" }, "parameters": [ { @@ -36672,14 +38426,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-suites-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/checks/suites#list-check-suites-for-a-git-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/checks/suites#list-check-suites-for-a-git-reference" }, "parameters": [ { @@ -36767,7 +38521,7 @@ "operationId": "repos/get-combined-status-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" }, "parameters": [ { @@ -36825,7 +38579,7 @@ "operationId": "repos/list-commit-statuses-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/statuses#list-commit-statuses-for-a-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/statuses#list-commit-statuses-for-a-reference" }, "parameters": [ { @@ -36884,14 +38638,14 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.13/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/compare-commits-with-basehead", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/commits#compare-two-commits" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/commits#compare-two-commits" }, "parameters": [ { @@ -36955,14 +38709,14 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.13/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.13/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", "tags": [ "repos" ], "operationId": "repos/get-content", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/contents#get-repository-content" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/contents#get-repository-content" }, "parameters": [ { @@ -37023,7 +38777,16 @@ { "$ref": "#/components/schemas/content-submodule" } - ] + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "array": "#/components/schemas/content-directory", + "file": "#/components/schemas/content-file", + "symlink": "#/components/schemas/content-symlink", + "submodule": "#/components/schemas/content-submodule" + } + } }, "examples": { "response-if-content-is-a-file": { @@ -37045,6 +38808,9 @@ "302": { "$ref": "#/components/responses/found" }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -37062,14 +38828,14 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.13/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], "operationId": "repos/create-or-update-file-contents", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/contents#create-or-update-file-contents" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/contents#create-or-update-file-contents" }, "parameters": [ { @@ -37225,7 +38991,21 @@ "$ref": "#/components/responses/not_found" }, "409": { - "$ref": "#/components/responses/conflict" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/basic-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } }, "422": { "$ref": "#/components/responses/validation_failed" @@ -37241,14 +39021,14 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.13/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], "operationId": "repos/delete-file", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/contents#delete-a-file" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/contents#delete-a-file" }, "parameters": [ { @@ -37384,7 +39164,7 @@ "operationId": "repos/list-contributors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-contributors" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-contributors" }, "parameters": [ { @@ -37462,7 +39242,7 @@ "operationId": "dependabot/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" }, "parameters": [ { @@ -37497,7 +39277,7 @@ }, { "name": "page", - "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", "deprecated": true, "in": "query", "schema": { @@ -37507,7 +39287,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "deprecated": true, "in": "query", "schema": { @@ -37583,7 +39363,7 @@ "operationId": "dependabot/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts#get-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts#get-a-dependabot-alert" }, "parameters": [ { @@ -37633,14 +39413,14 @@ }, "patch": { "summary": "Update a Dependabot alert", - "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "dependabot" ], "operationId": "dependabot/update-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts#update-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts#update-a-dependabot-alert" }, "parameters": [ { @@ -37754,7 +39534,7 @@ "operationId": "dependabot/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#list-repository-secrets" }, "parameters": [ { @@ -37826,7 +39606,7 @@ "operationId": "dependabot/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -37872,7 +39652,7 @@ "operationId": "dependabot/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#get-a-repository-secret" }, "parameters": [ { @@ -37912,14 +39692,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -37941,7 +39721,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -37998,7 +39778,7 @@ "operationId": "dependabot/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -38035,7 +39815,7 @@ "operationId": "dependency-graph/diff-range", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" }, "parameters": [ { @@ -38103,7 +39883,7 @@ "operationId": "dependency-graph/export-sbom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -38159,7 +39939,7 @@ "operationId": "dependency-graph/create-repository-snapshot", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" }, "parameters": [ { @@ -38244,7 +40024,7 @@ "operationId": "repos/list-deployments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#list-deployments" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#list-deployments" }, "parameters": [ { @@ -38336,14 +40116,14 @@ }, "post": { "summary": "Create a deployment", - "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@3.13/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#create-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#create-a-deployment" }, "parameters": [ { @@ -38376,7 +40156,7 @@ }, "required_contexts": { "type": "array", - "description": "The [status](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "description": "The [status](https://docs.github.com/enterprise-server@3.13/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "items": { "type": "string" } @@ -38509,7 +40289,7 @@ "operationId": "repos/get-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#get-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#get-a-deployment" }, "parameters": [ { @@ -38552,14 +40332,14 @@ }, "delete": { "summary": "Delete a deployment", - "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#delete-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#delete-a-deployment" }, "parameters": [ { @@ -38602,7 +40382,7 @@ "operationId": "repos/list-deployment-statuses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#list-deployment-statuses" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#list-deployment-statuses" }, "parameters": [ { @@ -38666,7 +40446,7 @@ "operationId": "repos/create-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#create-a-deployment-status" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#create-a-deployment-status" }, "parameters": [ { @@ -38701,7 +40481,7 @@ }, "target_url": { "type": "string", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.", "default": "" }, "log_url": { @@ -38792,7 +40572,7 @@ "operationId": "repos/get-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#get-a-deployment-status" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#get-a-deployment-status" }, "parameters": [ { @@ -38845,14 +40625,14 @@ "/repos/{owner}/{repo}/dispatches": { "post": { "summary": "Create a repository dispatch event", - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-dispatch-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-dispatch-event" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-dispatch-event" }, "parameters": [ { @@ -38880,7 +40660,7 @@ }, "client_payload": { "type": "object", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.", "additionalProperties": true, "maxProperties": 10 } @@ -38930,7 +40710,7 @@ "operationId": "repos/get-all-environments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/environments#list-environments" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/environments#list-environments" }, "parameters": [ { @@ -38988,14 +40768,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}": { "get": { "summary": "Get an environment", - "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/environments#get-an-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/environments#get-an-environment" }, "parameters": [ { @@ -39035,14 +40815,14 @@ }, "put": { "summary": "Create or update an environment", - "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/environments#create-or-update-an-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/environments#create-or-update-an-environment" }, "parameters": [ { @@ -39162,7 +40942,7 @@ "operationId": "repos/delete-an-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/environments#delete-an-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/environments#delete-an-environment" }, "parameters": [ { @@ -39199,7 +40979,7 @@ "operationId": "repos/list-deployment-branch-policies", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/branch-policies#list-deployment-branch-policies" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/branch-policies#list-deployment-branch-policies" }, "parameters": [ { @@ -39262,14 +41042,14 @@ }, "post": { "summary": "Create a deployment branch policy", - "description": "Creates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/branch-policies#create-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/branch-policies#create-a-deployment-branch-policy" }, "parameters": [ { @@ -39299,7 +41079,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" } } } @@ -39320,6 +41108,9 @@ }, "example-single-branch": { "$ref": "#/components/examples/deployment-branch-policy-single-branch" + }, + "example-single-tag": { + "$ref": "#/components/examples/deployment-branch-policy-single-tag" } } } @@ -39344,14 +41135,14 @@ "/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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/branch-policies#get-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/branch-policies#get-a-deployment-branch-policy" }, "parameters": [ { @@ -39394,14 +41185,14 @@ }, "put": { "summary": "Update a deployment branch policy", - "description": "Updates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/update-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/branch-policies#update-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/branch-policies#update-a-deployment-branch-policy" }, "parameters": [ { @@ -39461,14 +41252,14 @@ }, "delete": { "summary": "Delete a deployment branch policy", - "description": "Deletes a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/branch-policies#delete-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/branch-policies#delete-a-deployment-branch-policy" }, "parameters": [ { @@ -39501,14 +41292,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { "get": { "summary": "Get all deployment protection rules for an environment", - "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-all-deployment-protection-rules", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" }, "parameters": [ { @@ -39590,14 +41381,14 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" }, "parameters": [ { @@ -39662,14 +41453,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { "get": { "summary": "List custom deployment rule integrations available for an environment", - "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/list-custom-deployment-rule-integrations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" }, "parameters": [ { @@ -39730,14 +41521,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { "get": { "summary": "Get a custom deployment protection rule", - "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-custom-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" }, "parameters": [ { @@ -39787,7 +41578,7 @@ "operationId": "repos/disable-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" }, "parameters": [ { @@ -39827,7 +41618,7 @@ "operationId": "actions/list-environment-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#list-environment-secrets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#list-environment-secrets" }, "parameters": [ { @@ -39902,7 +41693,7 @@ "operationId": "actions/get-environment-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-an-environment-public-key" }, "parameters": [ { @@ -39951,7 +41742,7 @@ "operationId": "actions/get-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-an-environment-secret" }, "parameters": [ { @@ -39994,14 +41785,14 @@ }, "put": { "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-environment-secret" }, "parameters": [ { @@ -40026,7 +41817,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-an-environment-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -40087,7 +41878,7 @@ "operationId": "actions/delete-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#delete-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#delete-an-environment-secret" }, "parameters": [ { @@ -40127,7 +41918,7 @@ "operationId": "actions/list-environment-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#list-environment-variables" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#list-environment-variables" }, "parameters": [ { @@ -40200,7 +41991,7 @@ "operationId": "actions/create-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#create-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#create-an-environment-variable" }, "parameters": [ { @@ -40281,7 +42072,7 @@ "operationId": "actions/get-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#get-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#get-an-environment-variable" }, "parameters": [ { @@ -40331,7 +42122,7 @@ "operationId": "actions/update-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#update-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#update-an-environment-variable" }, "parameters": [ { @@ -40397,7 +42188,7 @@ "operationId": "actions/delete-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/actions/variables#delete-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.13/rest/actions/variables#delete-an-environment-variable" }, "parameters": [ { @@ -40430,14 +42221,14 @@ "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", - "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-repo-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-repository-events" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-repository-events" }, "parameters": [ { @@ -40492,7 +42283,7 @@ "operationId": "repos/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/forks#list-forks" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/forks#list-forks" }, "parameters": [ { @@ -40562,14 +42353,14 @@ }, "post": { "summary": "Create a fork", - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", + "description": "Create a fork for the authenticated user.\n\n> [!NOTE]\n> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", "tags": [ "repos" ], "operationId": "repos/create-fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/forks#create-a-fork" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/forks#create-a-fork" }, "parameters": [ { @@ -40661,7 +42452,7 @@ "operationId": "git/create-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/blobs#create-a-blob" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/blobs#create-a-blob" }, "parameters": [ { @@ -40737,7 +42528,21 @@ "$ref": "#/components/responses/conflict" }, "422": { - "$ref": "#/components/responses/validation_failed" + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } } }, "x-github": { @@ -40752,14 +42557,14 @@ "/repos/{owner}/{repo}/git/blobs/{file_sha}": { "get": { "summary": "Get a blob", - "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", "tags": [ "git" ], "operationId": "git/get-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/blobs#get-a-blob" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/blobs#get-a-blob" }, "parameters": [ { @@ -40818,14 +42623,14 @@ "/repos/{owner}/{repo}/git/commits": { "post": { "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/commits#create-a-commit" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/commits#create-a-commit" }, "parameters": [ { @@ -40852,7 +42657,7 @@ }, "parents": { "type": "array", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", "items": { "type": "string" } @@ -40975,14 +42780,14 @@ "/repos/{owner}/{repo}/git/commits/{commit_sha}": { "get": { "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/commits#get-a-commit-object" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/commits#get-a-commit-object" }, "parameters": [ { @@ -41030,14 +42835,14 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], "operationId": "git/list-matching-refs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/refs#list-matching-references" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/refs#list-matching-references" }, "parameters": [ { @@ -41090,14 +42895,14 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], "operationId": "git/get-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/refs#get-a-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/refs#get-a-reference" }, "parameters": [ { @@ -41152,7 +42957,7 @@ "operationId": "git/create-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/refs#create-a-reference" }, "parameters": [ { @@ -41244,7 +43049,7 @@ "operationId": "git/update-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/refs#update-a-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/refs#update-a-reference" }, "parameters": [ { @@ -41329,7 +43134,7 @@ "operationId": "git/delete-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/refs#delete-a-reference" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/refs#delete-a-reference" }, "parameters": [ { @@ -41365,14 +43170,14 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.13/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.13/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/tags#create-a-tag-object" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/tags#create-a-tag-object" }, "parameters": [ { @@ -41502,14 +43307,14 @@ "/repos/{owner}/{repo}/git/tags/{tag_sha}": { "get": { "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/get-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/tags#get-a-tag" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/tags#get-a-tag" }, "parameters": [ { @@ -41562,14 +43367,14 @@ "/repos/{owner}/{repo}/git/trees": { "post": { "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.11/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.11/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.13/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.13/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", "tags": [ "git" ], "operationId": "git/create-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/trees#create-a-tree" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/trees#create-a-tree" }, "parameters": [ { @@ -41630,7 +43435,7 @@ }, "base_tree": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n" + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." } }, "required": [ @@ -41704,14 +43509,14 @@ "/repos/{owner}/{repo}/git/trees/{tree_sha}": { "get": { "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", "tags": [ "git" ], "operationId": "git/get-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree" + "url": "https://docs.github.com/enterprise-server@3.13/rest/git/trees#get-a-tree" }, "parameters": [ { @@ -41788,7 +43593,7 @@ "operationId": "repos/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#list-repository-webhooks" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#list-repository-webhooks" }, "parameters": [ { @@ -41849,7 +43654,7 @@ "operationId": "repos/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#create-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#create-a-repository-webhook" }, "parameters": [ { @@ -41891,7 +43696,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -41980,7 +43785,7 @@ "operationId": "repos/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#get-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#get-a-repository-webhook" }, "parameters": [ { @@ -42030,7 +43835,7 @@ "operationId": "repos/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#update-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#update-a-repository-webhook" }, "parameters": [ { @@ -42055,7 +43860,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -42130,14 +43935,14 @@ }, "delete": { "summary": "Delete a repository webhook", - "description": "", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", "tags": [ "repos" ], "operationId": "repos/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#delete-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#delete-a-repository-webhook" }, "parameters": [ { @@ -42177,7 +43982,7 @@ "operationId": "repos/get-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -42224,7 +44029,7 @@ "operationId": "repos/update-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -42307,7 +44112,7 @@ "operationId": "repos/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" }, "parameters": [ { @@ -42324,14 +44129,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -42379,7 +44176,7 @@ "operationId": "repos/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -42437,7 +44234,7 @@ "operationId": "repos/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -42476,14 +44273,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { "post": { "summary": "Ping a repository webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) to be sent to the hook.", "tags": [ "repos" ], "operationId": "repos/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#ping-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#ping-a-repository-webhook" }, "parameters": [ { @@ -42516,14 +44313,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { "post": { "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", "tags": [ "repos" ], "operationId": "repos/test-push-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/webhooks#test-the-push-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/webhooks#test-the-push-repository-webhook" }, "parameters": [ { @@ -42556,14 +44353,14 @@ "/repos/{owner}/{repo}/installation": { "get": { "summary": "Get a repository installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-repo-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" }, "parameters": [ { @@ -42615,7 +44412,7 @@ "operationId": "repos/list-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/invitations#list-repository-invitations" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/invitations#list-repository-invitations" }, "parameters": [ { @@ -42675,7 +44472,7 @@ "operationId": "repos/update-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/invitations#update-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/invitations#update-a-repository-invitation" }, "parameters": [ { @@ -42753,7 +44550,7 @@ "operationId": "repos/delete-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/invitations#delete-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/invitations#delete-a-repository-invitation" }, "parameters": [ { @@ -42783,14 +44580,14 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#list-repository-issues" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#list-repository-issues" }, "parameters": [ { @@ -42925,14 +44722,14 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.11/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.13/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#create-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#create-an-issue" }, "parameters": [ { @@ -42966,7 +44763,7 @@ }, "assignee": { "type": "string", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_", "nullable": true }, "milestone": { @@ -43097,14 +44894,14 @@ "/repos/{owner}/{repo}/issues/comments": { "get": { "summary": "List issue comments for a repository", - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/comments#list-issue-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/comments#list-issue-comments-for-a-repository" }, "parameters": [ { @@ -43182,14 +44979,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}": { "get": { "summary": "Get an issue comment", - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment" }, "parameters": [ { @@ -43232,14 +45029,14 @@ }, "patch": { "summary": "Update an issue comment", - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/comments#update-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/comments#update-an-issue-comment" }, "parameters": [ { @@ -43315,7 +45112,7 @@ "operationId": "issues/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/comments#delete-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/comments#delete-an-issue-comment" }, "parameters": [ { @@ -43345,14 +45142,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for an issue comment", - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment).", + "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-an-issue-comment" }, "parameters": [ { @@ -43366,7 +45163,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", "in": "query", "required": false, "schema": { @@ -43428,14 +45225,14 @@ }, "post": { "summary": "Create reaction for an issue comment", - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-an-issue-comment" }, "parameters": [ { @@ -43457,7 +45254,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the issue comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the issue comment.", "enum": [ "+1", "-1", @@ -43531,14 +45328,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#delete-an-issue-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-an-issue-comment-reaction" }, "parameters": [ { @@ -43578,7 +45375,7 @@ "operationId": "issues/list-events-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/events#list-issue-events-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/events#list-issue-events-for-a-repository" }, "parameters": [ { @@ -43641,7 +45438,7 @@ "operationId": "issues/get-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/events#get-an-issue-event" }, "parameters": [ { @@ -43697,14 +45494,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.11/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.13/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue" }, "parameters": [ { @@ -43756,14 +45553,14 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -43803,7 +45600,7 @@ "assignee": { "type": "string", "nullable": true, - "description": "Username to assign to this issue. **This field is deprecated.**" + "description": "Username to assign to this issue. **This field is closing down.**" }, "state": { "type": "string", @@ -43948,7 +45745,7 @@ "operationId": "issues/add-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/assignees#add-assignees-to-an-issue" }, "parameters": [ { @@ -44105,7 +45902,7 @@ "operationId": "issues/check-user-can-be-assigned-to-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" }, "parameters": [ { @@ -44153,14 +45950,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/comments": { "get": { "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/comments#list-issue-comments" }, "parameters": [ { @@ -44223,14 +46020,14 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/comments#create-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -44326,7 +46123,7 @@ "operationId": "issues/list-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/events#list-issue-events" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/events#list-issue-events" }, "parameters": [ { @@ -44392,7 +46189,7 @@ "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#list-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -44462,7 +46259,7 @@ "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -44487,7 +46284,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.11/rest/issues/labels#set-labels-for-an-issue).\"", + "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.13/rest/issues/labels#set-labels-for-an-issue).\"", "items": { "type": "string" } @@ -44578,7 +46375,7 @@ "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -44603,7 +46400,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.11/rest/issues/labels#add-labels-to-an-issue).\"", + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.13/rest/issues/labels#add-labels-to-an-issue).\"", "items": { "type": "string" } @@ -44694,7 +46491,7 @@ "operationId": "issues/remove-all-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#remove-all-labels-from-an-issue" }, "parameters": [ { @@ -44740,7 +46537,7 @@ "operationId": "issues/remove-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#remove-a-label-from-an-issue" }, "parameters": [ { @@ -44802,14 +46599,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/lock": { "put": { "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "issues" ], "operationId": "issues/lock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#lock-an-issue" }, "parameters": [ { @@ -44887,7 +46684,7 @@ "operationId": "issues/unlock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#unlock-an-issue" }, "parameters": [ { @@ -44923,14 +46720,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { "get": { "summary": "List reactions for an issue", - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue).", + "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-an-issue" }, "parameters": [ { @@ -44944,7 +46741,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", "in": "query", "required": false, "schema": { @@ -45009,14 +46806,14 @@ }, "post": { "summary": "Create reaction for an issue", - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", + "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-an-issue" }, "parameters": [ { @@ -45038,7 +46835,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the issue.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the issue.", "enum": [ "+1", "-1", @@ -45112,14 +46909,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#delete-an-issue-reaction" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-an-issue-reaction" }, "parameters": [ { @@ -45159,7 +46956,7 @@ "operationId": "issues/list-events-for-timeline", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/timeline#list-timeline-events-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/timeline#list-timeline-events-for-an-issue" }, "parameters": [ { @@ -45228,7 +47025,7 @@ "operationId": "repos/list-deploy-keys", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deploy-keys/deploy-keys#list-deploy-keys" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deploy-keys/deploy-keys#list-deploy-keys" }, "parameters": [ { @@ -45286,7 +47083,7 @@ "operationId": "repos/create-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deploy-keys/deploy-keys#create-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deploy-keys/deploy-keys#create-a-deploy-key" }, "parameters": [ { @@ -45313,7 +47110,7 @@ }, "read_only": { "type": "boolean", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.11/articles/permission-levels-for-a-user-account-repository/).\"" + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.13/articles/permission-levels-for-a-user-account-repository/).\"" } }, "required": [ @@ -45379,7 +47176,7 @@ "operationId": "repos/get-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deploy-keys/deploy-keys#get-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deploy-keys/deploy-keys#get-a-deploy-key" }, "parameters": [ { @@ -45429,7 +47226,7 @@ "operationId": "repos/delete-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/deploy-keys/deploy-keys#delete-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/deploy-keys/deploy-keys#delete-a-deploy-key" }, "parameters": [ { @@ -45466,7 +47263,7 @@ "operationId": "issues/list-labels-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#list-labels-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#list-labels-for-a-repository" }, "parameters": [ { @@ -45527,7 +47324,7 @@ "operationId": "issues/create-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#create-a-label" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#create-a-label" }, "parameters": [ { @@ -45623,7 +47420,7 @@ "operationId": "issues/get-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#get-a-label" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#get-a-label" }, "parameters": [ { @@ -45678,7 +47475,7 @@ "operationId": "issues/update-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#update-a-label" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#update-a-label" }, "parameters": [ { @@ -45763,7 +47560,7 @@ "operationId": "issues/delete-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#delete-a-label" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#delete-a-label" }, "parameters": [ { @@ -45805,7 +47602,7 @@ "operationId": "repos/list-languages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-languages" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-languages" }, "parameters": [ { @@ -45851,7 +47648,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/lfs#enable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/lfs#enable-git-lfs-for-a-repository" }, "parameters": [ { @@ -45886,7 +47683,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/lfs#disable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/lfs#disable-git-lfs-for-a-repository" }, "parameters": [ { @@ -45913,14 +47710,14 @@ "/repos/{owner}/{repo}/license": { "get": { "summary": "Get the license for a repository", - "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "licenses" ], "operationId": "licenses/get-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/licenses/licenses#get-the-license-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/licenses/licenses#get-the-license-for-a-repository" }, "parameters": [ { @@ -45928,6 +47725,9 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref" } ], "responses": { @@ -45969,7 +47769,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -46047,7 +47847,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/branches/branches#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -46145,7 +47945,7 @@ "operationId": "issues/list-milestones", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/milestones#list-milestones" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/milestones#list-milestones" }, "parameters": [ { @@ -46249,7 +48049,7 @@ "operationId": "issues/create-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/milestones#create-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/milestones#create-a-milestone" }, "parameters": [ { @@ -46356,7 +48156,7 @@ "operationId": "issues/get-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/milestones#get-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/milestones#get-a-milestone" }, "parameters": [ { @@ -46406,7 +48206,7 @@ "operationId": "issues/update-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/milestones#update-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/milestones#update-a-milestone" }, "parameters": [ { @@ -46497,7 +48297,7 @@ "operationId": "issues/delete-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/milestones#delete-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/milestones#delete-a-milestone" }, "parameters": [ { @@ -46537,7 +48337,7 @@ "operationId": "issues/list-labels-for-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/labels#list-labels-for-issues-in-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/labels#list-labels-for-issues-in-a-milestone" }, "parameters": [ { @@ -46600,7 +48400,7 @@ "operationId": "activity/list-repo-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -46663,14 +48463,14 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-repo-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#mark-repository-notifications-as-read" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#mark-repository-notifications-as-read" }, "parameters": [ { @@ -46753,7 +48553,7 @@ "operationId": "repos/get-pages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#get-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#get-a-apiname-pages-site" }, "parameters": [ { @@ -46800,7 +48600,7 @@ "operationId": "repos/create-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#create-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#create-a-apiname-pages-site" }, "parameters": [ { @@ -46916,7 +48716,7 @@ "operationId": "repos/update-information-about-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#update-information-about-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#update-information-about-a-apiname-pages-site" }, "parameters": [ { @@ -46935,7 +48735,7 @@ "properties": { "cname": { "type": "string", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.11/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.13/pages/configuring-a-custom-domain-for-your-github-pages-site).\"", "nullable": true }, "https_enforced": { @@ -47059,7 +48859,7 @@ "operationId": "repos/delete-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#delete-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#delete-a-apiname-pages-site" }, "parameters": [ { @@ -47102,7 +48902,7 @@ "operationId": "repos/list-pages-builds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#list-apiname-pages-builds" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#list-apiname-pages-builds" }, "parameters": [ { @@ -47160,7 +48960,7 @@ "operationId": "repos/request-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#request-a-apiname-pages-build" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#request-a-apiname-pages-build" }, "parameters": [ { @@ -47206,7 +49006,7 @@ "operationId": "repos/get-latest-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#get-latest-pages-build" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#get-latest-pages-build" }, "parameters": [ { @@ -47252,7 +49052,7 @@ "operationId": "repos/get-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#get-apiname-pages-build" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#get-apiname-pages-build" }, "parameters": [ { @@ -47306,7 +49106,7 @@ "operationId": "repos/create-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pages/pages#create-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#create-a-github-pages-deployment" }, "parameters": [ { @@ -47398,6 +49198,98 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + "get": { + "summary": "Get the status of a GitHub Pages deployment", + "description": "Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.", + "tags": [ + "repos" + ], + "operationId": "repos/get-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#get-the-status-of-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pages-deployment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pages-deployment-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pages-deployment-status" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + "post": { + "summary": "Cancel a GitHub Pages deployment", + "description": "Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.", + "tags": [ + "repos" + ], + "operationId": "repos/cancel-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/pages/pages#cancel-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pages-deployment-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/pre-receive-hooks": { "get": { "summary": "List pre-receive hooks for a repository", @@ -47408,7 +49300,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository" }, "parameters": [ { @@ -47480,7 +49372,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository" }, "parameters": [ { @@ -47527,7 +49419,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository" }, "parameters": [ { @@ -47602,7 +49494,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository" }, "parameters": [ { @@ -47651,7 +49543,7 @@ "operationId": "projects/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#list-repository-projects" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#list-repository-projects" }, "parameters": [ { @@ -47739,7 +49631,7 @@ "operationId": "projects/create-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#create-a-repository-project" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#create-a-repository-project" }, "parameters": [ { @@ -47821,17 +49713,140 @@ "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 read 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-server@3.13/rest/repos/custom-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": "custom-properties" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/pulls": { "get": { "summary": "List pull requests", - "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests" }, "parameters": [ { @@ -47950,14 +49965,14 @@ }, "post": { "summary": "Create a pull request", - "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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#create-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#create-a-pull-request" }, "parameters": [ { @@ -47998,11 +50013,11 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.11/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.13/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." }, "draft": { "type": "boolean", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.11/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.13/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." }, "issue": { "type": "integer", @@ -48073,14 +50088,14 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#list-review-comments-in-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#list-review-comments-in-a-repository" }, "parameters": [ { @@ -48162,14 +50177,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -48212,14 +50227,14 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#update-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#update-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -48292,7 +50307,7 @@ "operationId": "pulls/delete-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -48325,14 +50340,14 @@ "/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.11/rest/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.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/list-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" }, "parameters": [ { @@ -48346,7 +50361,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", "required": false, "schema": { @@ -48408,14 +50423,14 @@ }, "post": { "summary": "Create reaction for a pull request review comment", - "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" }, "parameters": [ { @@ -48437,7 +50452,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", "enum": [ "+1", "-1", @@ -48511,14 +50526,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-pull-request-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#delete-a-pull-request-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-a-pull-request-comment-reaction" }, "parameters": [ { @@ -48551,14 +50566,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get a pull request", - "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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], "operationId": "pulls/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request" }, "parameters": [ { @@ -48573,7 +50588,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -48613,14 +50628,14 @@ }, "patch": { "summary": "Update a pull request", - "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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#update-a-pull-request" }, "parameters": [ { @@ -48662,7 +50677,7 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.11/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.13/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." } } }, @@ -48714,14 +50729,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#list-review-comments-on-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#list-review-comments-on-a-pull-request" }, "parameters": [ { @@ -48794,14 +50809,14 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#create-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#create-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -48835,7 +50850,7 @@ }, "position": { "type": "integer", - "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "deprecated": true, "x-github": { "deprecationDate": "2022-11-01" @@ -48843,7 +50858,7 @@ }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.11/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.13/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -48855,11 +50870,11 @@ }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -48947,14 +50962,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-reply-for-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#create-a-reply-for-a-review-comment" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#create-a-reply-for-a-review-comment" }, "parameters": [ { @@ -49037,14 +51052,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { "get": { "summary": "List commits on a pull request", - "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-commits-on-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-commits-on-a-pull-request" }, "parameters": [ { @@ -49100,14 +51115,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests-files" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests-files" }, "parameters": [ { @@ -49179,7 +51194,7 @@ "operationId": "pulls/check-if-merged", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" }, "parameters": [ { @@ -49210,14 +51225,14 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], "operationId": "pulls/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#merge-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#merge-a-pull-request" }, "parameters": [ { @@ -49361,14 +51376,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": [ "pulls" ], "operationId": "pulls/list-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -49514,7 +51529,7 @@ "operationId": "pulls/remove-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" }, "parameters": [ { @@ -49602,14 +51617,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { "get": { "summary": "List reviews for a pull request", - "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-reviews", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#list-reviews-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#list-reviews-for-a-pull-request" }, "parameters": [ { @@ -49663,14 +51678,14 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#create-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#create-a-review-for-a-pull-request" }, "parameters": [ { @@ -49700,7 +51715,7 @@ }, "event": { "type": "string", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -49805,14 +51820,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { "get": { "summary": "Get a review for a pull request", - "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#get-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#get-a-review-for-a-pull-request" }, "parameters": [ { @@ -49858,14 +51873,14 @@ }, "put": { "summary": "Update a review for a pull request", - "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#update-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#update-a-review-for-a-pull-request" }, "parameters": [ { @@ -49937,14 +51952,14 @@ }, "delete": { "summary": "Delete a pending review for a pull request", - "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/delete-pending-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" }, "parameters": [ { @@ -49995,14 +52010,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { "get": { "summary": "List comments for a pull request review", - "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-comments-for-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#list-comments-for-a-pull-request-review" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#list-comments-for-a-pull-request-review" }, "parameters": [ { @@ -50064,14 +52079,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/dismiss-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" }, "parameters": [ { @@ -50156,14 +52171,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { "post": { "summary": "Submit a review for a pull request", - "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/submit-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request" }, "parameters": [ { @@ -50253,14 +52268,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { "put": { "summary": "Update a pull request branch", - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.", "tags": [ "pulls" ], "operationId": "pulls/update-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#update-a-pull-request-branch" }, "parameters": [ { @@ -50283,7 +52298,7 @@ "properties": { "expected_head_sha": { "type": "string", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." } } }, @@ -50343,14 +52358,14 @@ "/repos/{owner}/{repo}/readme": { "get": { "summary": "Get a repository README", - "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/contents#get-a-repository-readme" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/contents#get-a-repository-readme" }, "parameters": [ { @@ -50385,6 +52400,9 @@ } } }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "404": { "$ref": "#/components/responses/not_found" }, @@ -50404,14 +52422,14 @@ "/repos/{owner}/{repo}/readme/{dir}": { "get": { "summary": "Get a repository README for a directory", - "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme-in-directory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/contents#get-a-repository-readme-for-a-directory" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/contents#get-a-repository-readme-for-a-directory" }, "parameters": [ { @@ -50475,14 +52493,14 @@ "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", "tags": [ "repos" ], "operationId": "repos/list-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#list-releases" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#list-releases" }, "parameters": [ { @@ -50536,14 +52554,14 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], "operationId": "repos/create-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#create-a-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#create-a-release" }, "parameters": [ { @@ -50599,7 +52617,7 @@ "false", "legacy" ], - "default": true + "default": "true" } }, "required": [ @@ -50663,14 +52681,14 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], "operationId": "repos/get-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/assets#get-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/assets#get-a-release-asset" }, "parameters": [ { @@ -50723,7 +52741,7 @@ "operationId": "repos/update-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/assets#update-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/assets#update-a-release-asset" }, "parameters": [ { @@ -50802,7 +52820,7 @@ "operationId": "repos/delete-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/assets#delete-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/assets#delete-a-release-asset" }, "parameters": [ { @@ -50832,14 +52850,14 @@ "/repos/{owner}/{repo}/releases/generate-notes": { "post": { "summary": "Generate release notes content for a release", - "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", + "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", "tags": [ "repos" ], "operationId": "repos/generate-release-notes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#generate-release-notes-content-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#generate-release-notes-content-for-a-release" }, "parameters": [ { @@ -50929,7 +52947,7 @@ "operationId": "repos/get-latest-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-the-latest-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-the-latest-release" }, "parameters": [ { @@ -50975,7 +52993,7 @@ "operationId": "repos/get-release-by-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release-by-tag-name" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release-by-tag-name" }, "parameters": [ { @@ -51027,14 +53045,14 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], "operationId": "repos/get-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release" }, "parameters": [ { @@ -51049,7 +53067,7 @@ ], "responses": { "200": { - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "content": { "application/json": { "schema": { @@ -51084,7 +53102,7 @@ "operationId": "repos/update-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#update-a-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#update-a-release" }, "parameters": [ { @@ -51189,7 +53207,7 @@ "operationId": "repos/delete-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/releases#delete-a-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/releases#delete-a-release" }, "parameters": [ { @@ -51226,7 +53244,7 @@ "operationId": "repos/list-release-assets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/assets#list-release-assets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/assets#list-release-assets" }, "parameters": [ { @@ -51280,18 +53298,18 @@ }, "post": { "summary": "Upload a release asset", - "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-server@3.11/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", + "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-server@3.13/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", "tags": [ "repos" ], "operationId": "repos/upload-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/releases/assets#upload-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/releases/assets#upload-a-release-asset" }, "servers": [ { - "url": "https://uploads.github.com", + "url": "https://HOSTNAME/api/uploads", "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], @@ -51370,14 +53388,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions": { "get": { "summary": "List reactions for a release", - "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release).", + "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/list-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-release" }, "parameters": [ { @@ -51391,7 +53409,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", "in": "query", "required": false, "schema": { @@ -51451,14 +53469,14 @@ }, "post": { "summary": "Create reaction for a release", - "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", + "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", "tags": [ "reactions" ], "operationId": "reactions/create-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-release" }, "parameters": [ { @@ -51480,7 +53498,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the release.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the release.", "enum": [ "+1", "laugh", @@ -51552,14 +53570,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#delete-a-release-reaction" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-a-release-reaction" }, "parameters": [ { @@ -51599,7 +53617,7 @@ "operationId": "repos/list-cache-info", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-cache-replication-status" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-cache-replication-status" }, "parameters": [ { @@ -51726,7 +53744,7 @@ "operationId": "repos/get-branch-rules", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/rules#get-rules-for-a-branch" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/rules#get-rules-for-a-branch" }, "parameters": [ { @@ -51784,7 +53802,7 @@ "operationId": "repos/get-repo-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/rules#get-all-repository-rulesets" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/rules#get-all-repository-rulesets" }, "x-github": { "githubCloudOnly": false, @@ -51814,6 +53832,9 @@ "type": "boolean", "default": true } + }, + { + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -51853,7 +53874,7 @@ "operationId": "repos/create-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/rules#create-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/rules#create-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -51883,11 +53904,13 @@ }, "target": { "type": "string", - "description": "The target of the ruleset.", + "description": "The target of the ruleset", "enum": [ "branch", - "tag" - ] + "tag", + "push" + ], + "default": "branch" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" @@ -51980,23 +54003,87 @@ "x-octokit": {} } }, - "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + "/repos/{owner}/{repo}/rulesets/rule-suites": { "get": { - "summary": "Get a repository ruleset", - "description": "Get a ruleset for a repository.", + "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-server@3.13/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-ruleset", + "operationId": "repos/get-repo-rule-suites", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/rules#get-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/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": "rules" + "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-server@3.13/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-server@3.13/rest/repos/rule-suites#get-a-repository-rule-suite" }, "parameters": [ { @@ -52006,23 +54093,7 @@ "$ref": "#/components/parameters/repo" }, { - "name": "ruleset_id", - "description": "The ID of the ruleset.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "includes_parents", - "description": "Include rulesets configured at higher levels that apply to this repository", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": true - } + "$ref": "#/components/parameters/rule-suite-id" } ], "responses": { @@ -52031,11 +54102,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/repository-ruleset" + "$ref": "#/components/schemas/rule-suite" }, "examples": { "default": { - "$ref": "#/components/examples/repository-ruleset" + "$ref": "#/components/examples/rule-suite" } } } @@ -52048,18 +54119,95 @@ "$ref": "#/components/responses/internal_error" } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rule-suites" + }, "x-octokit": {} - }, - "put": { - "summary": "Update a repository ruleset", - "description": "Update a ruleset for a repository.", + } + }, + "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get a repository ruleset", + "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", "tags": [ "repos" ], - "operationId": "repos/update-repo-ruleset", + "operationId": "repos/get-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/rules#update-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/rules#get-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "includes_parents", + "description": "Include rulesets configured at higher levels that apply to this repository", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "put": { + "summary": "Update a repository ruleset", + "description": "Update a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/update-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/rules#update-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -52098,10 +54246,11 @@ }, "target": { "type": "string", - "description": "The target of the ruleset.", + "description": "The target of the ruleset", "enum": [ "branch", - "tag" + "tag", + "push" ] }, "enforcement": { @@ -52199,7 +54348,7 @@ "operationId": "repos/delete-repo-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/rules#delete-a-repository-ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/rules#delete-a-repository-ruleset" }, "x-github": { "githubCloudOnly": false, @@ -52248,7 +54397,7 @@ "operationId": "secret-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -52283,6 +54432,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -52330,7 +54482,7 @@ "operationId": "secret-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" }, "parameters": [ { @@ -52386,7 +54538,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" }, "parameters": [ { @@ -52479,7 +54631,7 @@ "operationId": "secret-scanning/list-locations-for-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.13/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" }, "parameters": [ { @@ -52542,14 +54694,14 @@ "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", - "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-stargazers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/starring#list-stargazers" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/starring#list-stargazers" }, "parameters": [ { @@ -52625,7 +54777,7 @@ "operationId": "repos/get-code-frequency-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/metrics/statistics#get-the-weekly-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.13/rest/metrics/statistics#get-the-weekly-commit-activity" }, "parameters": [ { @@ -52680,7 +54832,7 @@ "operationId": "repos/get-commit-activity-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/metrics/statistics#get-the-last-year-of-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.13/rest/metrics/statistics#get-the-last-year-of-commit-activity" }, "parameters": [ { @@ -52735,7 +54887,7 @@ "operationId": "repos/get-contributors-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/metrics/statistics#get-all-contributor-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.13/rest/metrics/statistics#get-all-contributor-commit-activity" }, "parameters": [ { @@ -52790,7 +54942,7 @@ "operationId": "repos/get-participation-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/metrics/statistics#get-the-weekly-commit-count" + "url": "https://docs.github.com/enterprise-server@3.13/rest/metrics/statistics#get-the-weekly-commit-count" }, "parameters": [ { @@ -52839,7 +54991,7 @@ "operationId": "repos/get-punch-card-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" + "url": "https://docs.github.com/enterprise-server@3.13/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" }, "parameters": [ { @@ -52891,7 +55043,7 @@ "operationId": "repos/create-commit-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/commits/statuses#create-a-commit-status" + "url": "https://docs.github.com/enterprise-server@3.13/rest/commits/statuses#create-a-commit-status" }, "parameters": [ { @@ -53004,7 +55156,7 @@ "operationId": "activity/list-watchers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/watching#list-watchers" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/watching#list-watchers" }, "parameters": [ { @@ -53064,7 +55216,7 @@ "operationId": "activity/get-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/watching#get-a-repository-subscription" }, "parameters": [ { @@ -53107,14 +55259,14 @@ }, "put": { "summary": "Set a repository subscription", - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#delete-a-repository-subscription) completely.", + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#delete-a-repository-subscription) completely.", "tags": [ "activity" ], "operationId": "activity/set-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/watching#set-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/watching#set-a-repository-subscription" }, "parameters": [ { @@ -53179,14 +55331,14 @@ }, "delete": { "summary": "Delete a repository subscription", - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#set-a-repository-subscription).", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#set-a-repository-subscription).", "tags": [ "activity" ], "operationId": "activity/delete-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/watching#delete-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/watching#delete-a-repository-subscription" }, "parameters": [ { @@ -53220,7 +55372,7 @@ "operationId": "repos/list-tags", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-tags" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-tags" }, "parameters": [ { @@ -53272,15 +55424,15 @@ }, "/repos/{owner}/{repo}/tags/protection": { "get": { - "summary": "List tag protection states for a repository", - "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", + "summary": "Closing down - List tag protection states for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/list-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/tags#list-tag-protection-states-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository" }, "parameters": [ { @@ -53320,20 +55472,23 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} }, "post": { - "summary": "Create a tag protection state for a repository", - "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Create a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/create-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/tags#create-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -53396,22 +55551,25 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { "delete": { - "summary": "Delete a tag protection state for a repository", - "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Delete a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/delete-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/tags#delete-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -53439,21 +55597,24 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tarball/{ref}": { "get": { "summary": "Download a repository archive (tar)", - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", "tags": [ "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/contents#download-a-repository-archive-tar" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/contents#download-a-repository-archive-tar" }, "operationId": "repos/download-tarball-archive", "parameters": [ @@ -53515,7 +55676,7 @@ "operationId": "repos/list-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-teams" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-teams" }, "parameters": [ { @@ -53578,7 +55739,7 @@ "operationId": "repos/get-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-all-repository-topics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#get-all-repository-topics" }, "parameters": [ { @@ -53631,7 +55792,7 @@ "operationId": "repos/replace-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#replace-all-repository-topics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#replace-all-repository-topics" }, "parameters": [ { @@ -53650,7 +55811,7 @@ "properties": { "names": { "type": "array", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.", "items": { "type": "string" } @@ -53710,14 +55871,14 @@ "/repos/{owner}/{repo}/transfer": { "post": { "summary": "Transfer a repository", - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.11/articles/about-repository-transfers/).", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.13/articles/about-repository-transfers/).", "tags": [ "repos" ], "operationId": "repos/transfer", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#transfer-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#transfer-a-repository" }, "parameters": [ { @@ -53798,14 +55959,14 @@ "/repos/{owner}/{repo}/vulnerability-alerts": { "get": { "summary": "Check if vulnerability alerts are enabled for a repository", - "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/check-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" }, "parameters": [ { @@ -53833,14 +55994,14 @@ }, "put": { "summary": "Enable vulnerability alerts", - "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/enable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#enable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#enable-vulnerability-alerts" }, "parameters": [ { @@ -53865,14 +56026,14 @@ }, "delete": { "summary": "Disable vulnerability alerts", - "description": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/disable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#disable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#disable-vulnerability-alerts" }, "parameters": [ { @@ -53899,13 +56060,13 @@ "/repos/{owner}/{repo}/zipball/{ref}": { "get": { "summary": "Download a repository archive (zip)", - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "tags": [ "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/contents#download-a-repository-archive-zip" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/contents#download-a-repository-archive-zip" }, "operationId": "repos/download-zipball-archive", "parameters": [ @@ -53960,14 +56121,14 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "tags": [ "repos" ], "operationId": "repos/create-using-template", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-using-a-template" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-using-a-template" }, "parameters": [ { @@ -54064,14 +56225,14 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "repos", "subcategory": "repos", "previews": [ { "required": true, "name": "baptiste", - "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -54081,14 +56242,14 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", "tags": [ "repos" ], "operationId": "repos/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-public-repositories" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-public-repositories" }, "parameters": [ { @@ -54156,7 +56317,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -54164,7 +56325,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" }, "parameters": [ { @@ -54239,14 +56400,14 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, "parameters": [ { @@ -54321,14 +56482,14 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" }, "parameters": [ { @@ -54386,14 +56547,14 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" }, "parameters": [ { @@ -54496,14 +56657,14 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" }, "parameters": [ { @@ -54616,14 +56777,14 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nDeletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" }, "parameters": [ { @@ -54668,14 +56829,14 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" }, "parameters": [ { @@ -54747,14 +56908,14 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, "parameters": [ { @@ -54829,14 +56990,14 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" }, "parameters": [ { @@ -54891,14 +57052,14 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" }, "parameters": [ { @@ -54971,14 +57132,14 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" }, "parameters": [ { @@ -55109,14 +57270,14 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" }, "parameters": [ { @@ -55161,19 +57322,19 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", "tags": [ "search" ], "operationId": "search/code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/search/search#search-code" + "url": "https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -55182,7 +57343,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -55273,19 +57434,19 @@ "/search/commits": { "get": { "summary": "Search commits", - "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", "tags": [ "search" ], "operationId": "search/commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/search/search#search-commits" + "url": "https://docs.github.com/enterprise-server@3.13/rest/search/search#search-commits" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -55294,7 +57455,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -55366,19 +57527,19 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.11/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.13/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], "operationId": "search/issues-and-pull-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/search/search#search-issues-and-pull-requests" + "url": "https://docs.github.com/enterprise-server@3.13/rest/search/search#search-issues-and-pull-requests" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -55387,7 +57548,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -55477,14 +57638,14 @@ "/search/labels": { "get": { "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/search/search#search-labels" + "url": "https://docs.github.com/enterprise-server@3.13/rest/search/search#search-labels" }, "parameters": [ { @@ -55498,7 +57659,7 @@ }, { "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query).", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -55507,7 +57668,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -55588,19 +57749,19 @@ "/search/repositories": { "get": { "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], "operationId": "search/repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/search/search#search-repositories" + "url": "https://docs.github.com/enterprise-server@3.13/rest/search/search#search-repositories" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.11/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.13/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -55609,7 +57770,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -55689,19 +57850,19 @@ "/search/topics": { "get": { "summary": "Search topics", - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-server@3.11/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-server@3.13/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/search/search#search-topics" + "url": "https://docs.github.com/enterprise-server@3.13/rest/search/search#search-topics" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query).", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -55766,19 +57927,19 @@ "/search/users": { "get": { "summary": "Search users", - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-server@3.11/graphql/reference/queries#search).\"", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-server@3.13/graphql/reference/queries#search).\"", "tags": [ "search" ], "operationId": "search/users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/search/search#search-users" + "url": "https://docs.github.com/enterprise-server@3.13/rest/search/search#search-users" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -55787,7 +57948,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -55873,7 +58034,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-the-configuration-status" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-the-configuration-status" }, "servers": [ { @@ -55929,7 +58090,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#start-a-configuration-process" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process" }, "servers": [ { @@ -55973,7 +58134,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-the-maintenance-status" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-the-maintenance-status" }, "servers": [ { @@ -56020,14 +58181,14 @@ }, "post": { "summary": "Enable or disable maintenance mode", - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "> [!NOTE]\n> The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", "operationId": "enterprise-admin/enable-or-disable-maintenance-mode", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode" }, "servers": [ { @@ -56102,14 +58263,14 @@ "/setup/api/settings": { "get": { "summary": "Get settings", - "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API.", + "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings).\n\n> [!NOTE]\n> You cannot retrieve the management console password with the Enterprise administration API.", "operationId": "enterprise-admin/get-settings", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings" }, "servers": [ { @@ -56156,14 +58317,14 @@ }, "put": { "summary": "Set settings", - "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", + "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", "operationId": "enterprise-admin/set-settings", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#set-settings" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings" }, "servers": [ { @@ -56197,7 +58358,7 @@ "properties": { "settings": { "type": "string", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings)." + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings)." } }, "required": [ @@ -56233,7 +58394,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys" }, "servers": [ { @@ -56290,7 +58451,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#add-an-authorized-ssh-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#add-an-authorized-ssh-key" }, "servers": [ { @@ -56373,7 +58534,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key" }, "servers": [ { @@ -56451,14 +58612,14 @@ "/setup/api/start": { "post": { "summary": "Create a GitHub license", - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/create-enterprise-server-license", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#create-a-github-license" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#create-a-github-license" }, "servers": [ { @@ -56500,7 +58661,7 @@ }, "settings": { "type": "string", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings)." + "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings)." } }, "required": [ @@ -56530,14 +58691,14 @@ "/setup/api/upgrade": { "post": { "summary": "Upgrade a license", - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "This API upgrades your license and also triggers the configuration process.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/upgrade-license", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#upgrade-a-license" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#upgrade-a-license" }, "servers": [ { @@ -56597,14 +58758,14 @@ "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -56644,14 +58805,14 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], "operationId": "teams/update-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#update-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -56691,7 +58852,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -56776,14 +58937,14 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], "operationId": "teams/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#delete-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#delete-a-team-legacy" }, "parameters": [ { @@ -56816,14 +58977,14 @@ "/teams/{team_id}/discussions": { "get": { "summary": "List discussions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions-legacy" }, "parameters": [ { @@ -56877,14 +59038,14 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#create-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion-legacy" }, "parameters": [ { @@ -56961,14 +59122,14 @@ "/teams/{team_id}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion-legacy" }, "parameters": [ { @@ -57008,14 +59169,14 @@ }, "patch": { "summary": "Update a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#update-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#update-a-discussion-legacy" }, "parameters": [ { @@ -57082,14 +59243,14 @@ }, "delete": { "summary": "Delete a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#delete-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion-legacy" }, "parameters": [ { @@ -57119,14 +59280,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#list-discussion-comments-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -57183,14 +59344,14 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#create-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -57259,14 +59420,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -57309,14 +59470,14 @@ }, "patch": { "summary": "Update a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#update-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -57385,14 +59546,14 @@ }, "delete": { "summary": "Delete a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#delete-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment-legacy" }, "parameters": [ { @@ -57425,14 +59586,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" }, "parameters": [ { @@ -57446,7 +59607,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", "required": false, "schema": { @@ -57508,14 +59669,14 @@ }, "post": { "summary": "Create reaction for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" }, "parameters": [ { @@ -57537,7 +59698,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "enum": [ "+1", "-1", @@ -57596,14 +59757,14 @@ "/teams/{team_id}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" }, "parameters": [ { @@ -57614,7 +59775,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "query", "required": false, "schema": { @@ -57676,14 +59837,14 @@ }, "post": { "summary": "Create reaction for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" }, "parameters": [ { @@ -57702,7 +59863,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ "+1", "-1", @@ -57761,14 +59922,14 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.11/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.13/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], "operationId": "teams/list-members-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#list-team-members-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#list-team-members-legacy" }, "parameters": [ { @@ -57839,14 +60000,14 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], "operationId": "teams/get-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-member-legacy" }, "parameters": [ { @@ -57877,14 +60038,14 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-team-member-legacy" }, "parameters": [ { @@ -57921,14 +60082,14 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-member-legacy" }, "parameters": [ { @@ -57961,14 +60122,14 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -58011,14 +60172,14 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -58096,14 +60257,14 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -58136,14 +60297,14 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "tags": [ "teams" ], "operationId": "teams/list-projects-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects-legacy" }, "parameters": [ { @@ -58199,14 +60360,14 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-project-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-project-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-project-legacy" }, "parameters": [ { @@ -58249,14 +60410,14 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", "tags": [ "teams" ], "operationId": "teams/add-or-update-project-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions-legacy" }, "parameters": [ { @@ -58275,7 +60436,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "enum": [ "read", "write", @@ -58318,7 +60479,7 @@ "response-if-the-project-is-not-owned-by-the-organization": { "value": { "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions" + "documentation_url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions" } } } @@ -58345,14 +60506,14 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", "tags": [ "teams" ], "operationId": "teams/remove-project-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-project-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-project-from-a-team-legacy" }, "parameters": [ { @@ -58388,14 +60549,14 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-repositories-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -58451,14 +60612,14 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-repository-legacy" }, "parameters": [ { @@ -58507,14 +60668,14 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-repository-permissions-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-repository-permissions-legacy" }, "parameters": [ { @@ -58580,14 +60741,14 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], "operationId": "teams/remove-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-repository-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-repository-from-a-team-legacy" }, "parameters": [ { @@ -58620,14 +60781,14 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-child-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-child-teams-legacy" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-child-teams-legacy" }, "parameters": [ { @@ -58696,7 +60857,7 @@ "operationId": "users/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/users#get-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/users#get-the-authenticated-user" }, "parameters": [], "responses": { @@ -58712,7 +60873,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "response-with-public-and-private-profile-information": { @@ -58752,7 +60920,7 @@ "operationId": "users/update-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/users#update-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/users#update-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -58866,7 +61034,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" }, "responses": { "200": { @@ -58907,7 +61075,7 @@ "operationId": "users/list-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/emails#list-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/emails#list-email-addresses-for-the-authenticated-user" }, "parameters": [ { @@ -58981,7 +61149,7 @@ "operationId": "users/add-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/emails#add-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/emails#add-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -58998,9 +61166,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 + "example": "username@example.com" }, + "minItems": 1, "example": [] } }, @@ -59093,7 +61261,7 @@ "operationId": "users/delete-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/emails#delete-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/emails#delete-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -59110,9 +61278,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 - } + "example": "username@example.com" + }, + "minItems": 1 } }, "example": { @@ -59190,7 +61358,7 @@ "operationId": "users/list-followers-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#list-followers-of-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#list-followers-of-the-authenticated-user" }, "parameters": [ { @@ -59253,7 +61421,7 @@ "operationId": "users/list-followed-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#list-the-people-the-authenticated-user-follows" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#list-the-people-the-authenticated-user-follows" }, "parameters": [ { @@ -59326,7 +61494,7 @@ "operationId": "users/check-person-is-followed-by-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" }, "parameters": [ { @@ -59367,14 +61535,14 @@ }, "put": { "summary": "Follow a user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/follow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#follow-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#follow-a-user" }, "parameters": [ { @@ -59396,6 +61564,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -59415,7 +61586,7 @@ "operationId": "users/unfollow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#unfollow-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#unfollow-a-user" }, "parameters": [ { @@ -59458,7 +61629,7 @@ "operationId": "users/list-gpg-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" }, "parameters": [ { @@ -59532,7 +61703,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -59627,7 +61798,7 @@ "operationId": "users/get-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -59690,7 +61861,7 @@ "operationId": "users/delete-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -59746,7 +61917,7 @@ "operationId": "apps/list-installations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" }, "parameters": [ { @@ -59821,7 +61992,7 @@ "operationId": "apps/list-installation-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" }, "parameters": [ { @@ -59895,14 +62066,14 @@ "/user/installations/{installation_id}/repositories/{repository_id}": { "put": { "summary": "Add a repository to an app installation", - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], "operationId": "apps/add-repo-to-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/installations#add-a-repository-to-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/installations#add-a-repository-to-an-app-installation" }, "parameters": [ { @@ -59946,14 +62117,14 @@ }, "delete": { "summary": "Remove a repository from an app installation", - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], "operationId": "apps/remove-repo-from-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/installations#remove-a-repository-from-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/installations#remove-a-repository-from-an-app-installation" }, "parameters": [ { @@ -60002,14 +62173,14 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -60126,7 +62297,7 @@ "operationId": "users/list-public-ssh-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" }, "parameters": [ { @@ -60200,7 +62371,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -60297,7 +62468,7 @@ "operationId": "users/get-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -60360,7 +62531,7 @@ "operationId": "users/delete-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -60413,7 +62584,7 @@ "operationId": "orgs/list-memberships-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" }, "parameters": [ { @@ -60492,7 +62663,7 @@ "operationId": "orgs/get-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -60539,7 +62710,7 @@ "operationId": "orgs/update-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -60620,7 +62791,7 @@ "operationId": "migrations/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/users#list-user-migrations" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/users#list-user-migrations" }, "parameters": [ { @@ -60681,7 +62852,7 @@ "operationId": "migrations/start-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/users#start-a-user-migration" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/users#start-a-user-migration" }, "parameters": [], "requestBody": { @@ -60823,7 +62994,7 @@ "operationId": "migrations/get-archive-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/users#download-a-user-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/users#download-a-user-migration-archive" }, "parameters": [ { @@ -60863,7 +63034,7 @@ "operationId": "migrations/list-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/migrations/users#list-repositories-for-a-user-migration" + "url": "https://docs.github.com/enterprise-server@3.13/rest/migrations/users#list-repositories-for-a-user-migration" }, "parameters": [ { @@ -60926,14 +63097,14 @@ "/user/orgs": { "get": { "summary": "List organizations for the authenticated user", - "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.", "tags": [ "orgs" ], "operationId": "orgs/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#list-organizations-for-the-authenticated-user" }, "parameters": [ { @@ -60989,14 +63160,14 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" }, "parameters": [ { @@ -61061,14 +63232,14 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -61105,14 +63276,14 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#delete-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#delete-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -61148,14 +63319,14 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#restore-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#restore-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -61200,14 +63371,14 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { @@ -61288,14 +63459,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -61335,14 +63506,14 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -61381,14 +63552,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -61434,7 +63605,7 @@ "operationId": "projects/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#create-a-user-project" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#create-a-user-project" }, "parameters": [], "requestBody": { @@ -61513,14 +63684,14 @@ "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", - "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/list-public-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" }, "parameters": [ { @@ -61596,7 +63767,7 @@ "operationId": "repos/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repositories-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repositories-for-the-authenticated-user" }, "parameters": [ { @@ -61732,7 +63903,7 @@ "operationId": "repos/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -61838,7 +64009,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -61855,7 +64026,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -61960,7 +64131,7 @@ "operationId": "repos/list-invitations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" }, "parameters": [ { @@ -62026,7 +64197,7 @@ "operationId": "repos/accept-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/invitations#accept-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/invitations#accept-a-repository-invitation" }, "parameters": [ { @@ -62077,7 +64248,7 @@ "operationId": "repos/decline-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/collaborators/invitations#decline-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.13/rest/collaborators/invitations#decline-a-repository-invitation" }, "parameters": [ { @@ -62130,7 +64301,7 @@ "operationId": "users/list-social-accounts-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" }, "parameters": [ { @@ -62194,7 +64365,7 @@ "operationId": "users/add-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -62290,7 +64461,7 @@ "operationId": "users/delete-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -62373,7 +64544,7 @@ "operationId": "users/list-ssh-signing-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" }, "parameters": [ { @@ -62438,7 +64609,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -62453,7 +64624,7 @@ "example": "Personal MacBook Air" }, "key": { - "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.11/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.13/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", "type": "string", "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " } @@ -62525,7 +64696,7 @@ "operationId": "users/get-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -62578,7 +64749,7 @@ "operationId": "users/delete-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -62614,14 +64785,14 @@ "/user/starred": { "get": { "summary": "List repositories starred by the authenticated user", - "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" }, "parameters": [ { @@ -62703,7 +64874,7 @@ "operationId": "activity/check-repo-is-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" }, "parameters": [ { @@ -62747,14 +64918,14 @@ }, "put": { "summary": "Star a repository for the authenticated user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "activity" ], "operationId": "activity/star-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/starring#star-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/starring#star-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -62798,7 +64969,7 @@ "operationId": "activity/unstar-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -62844,7 +65015,7 @@ "operationId": "activity/list-watched-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" }, "parameters": [ { @@ -62907,7 +65078,7 @@ "operationId": "teams/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-teams-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-teams-for-the-authenticated-user" }, "parameters": [ { @@ -62960,17 +65131,80 @@ "x-octokit": {} } }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.13/rest/users/emails)\".", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + }, + "x-octokit": {} + } + }, "/users": { "get": { "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", "tags": [ "users" ], "operationId": "users/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/users#list-users" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/users#list-users" }, "parameters": [ { @@ -63023,14 +65257,14 @@ "/users/{username}": { "get": { "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.11/rest/users/emails)\".", + "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.13/rest/users/emails)\".", "tags": [ "users" ], "operationId": "users/get-by-username", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/users#get-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/users#get-a-user" }, "parameters": [ { @@ -63050,7 +65284,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "default-response": { @@ -63086,7 +65327,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" }, "parameters": [ { @@ -63131,14 +65372,14 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-events-for-the-authenticated-user" }, "parameters": [ { @@ -63183,14 +65424,14 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-org-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-organization-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-organization-events-for-the-authenticated-user" }, "parameters": [ { @@ -63238,14 +65479,14 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-public-events-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-public-events-for-a-user" }, "parameters": [ { @@ -63297,7 +65538,7 @@ "operationId": "users/list-followers-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#list-followers-of-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#list-followers-of-a-user" }, "parameters": [ { @@ -63354,7 +65595,7 @@ "operationId": "users/list-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#list-the-people-a-user-follows" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#list-the-people-a-user-follows" }, "parameters": [ { @@ -63411,7 +65652,7 @@ "operationId": "users/check-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/followers#check-if-a-user-follows-another-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/followers#check-if-a-user-follows-another-user" }, "parameters": [ { @@ -63453,7 +65694,7 @@ "operationId": "gists/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/gists/gists#list-gists-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/gists/gists#list-gists-for-a-user" }, "parameters": [ { @@ -63516,7 +65757,7 @@ "operationId": "users/list-gpg-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/gpg-keys#list-gpg-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/gpg-keys#list-gpg-keys-for-a-user" }, "parameters": [ { @@ -63573,7 +65814,7 @@ "operationId": "users/get-context-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/users#get-contextual-information-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/users#get-contextual-information-for-a-user" }, "parameters": [ { @@ -63639,14 +65880,14 @@ "/users/{username}/installation": { "get": { "summary": "Get a user installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-user-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" }, "parameters": [ { @@ -63689,7 +65930,7 @@ "operationId": "users/list-public-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/keys#list-public-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/keys#list-public-keys-for-a-user" }, "parameters": [ { @@ -63739,14 +65980,14 @@ "/users/{username}/orgs": { "get": { "summary": "List organizations for a user", - "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.11/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.13/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", "tags": [ "orgs" ], "operationId": "orgs/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#list-organizations-for-a-user" }, "parameters": [ { @@ -63796,14 +66037,14 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#list-packages-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#list-packages-for-a-user" }, "parameters": [ { @@ -63877,14 +66118,14 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-a-package-for-a-user" }, "parameters": [ { @@ -63924,14 +66165,14 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#delete-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#delete-a-package-for-a-user" }, "parameters": [ { @@ -63970,14 +66211,14 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#restore-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#restore-a-package-for-a-user" }, "parameters": [ { @@ -64025,14 +66266,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by a user", - "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" }, "parameters": [ { @@ -64086,14 +66327,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#get-a-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#get-a-package-version-for-a-user" }, "parameters": [ { @@ -64136,14 +66377,14 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#delete-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#delete-package-version-for-a-user" }, "parameters": [ { @@ -64185,14 +66426,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/packages/packages#restore-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/packages/packages#restore-package-version-for-a-user" }, "parameters": [ { @@ -64241,7 +66482,7 @@ "operationId": "projects/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/projects/projects#list-user-projects" + "url": "https://docs.github.com/enterprise-server@3.13/rest/projects/projects#list-user-projects" }, "parameters": [ { @@ -64309,14 +66550,14 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-received-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-events-received-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-events-received-by-the-authenticated-user" }, "parameters": [ { @@ -64361,14 +66602,14 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-received-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/events#list-public-events-received-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/events#list-public-events-received-by-a-user" }, "parameters": [ { @@ -64420,7 +66661,7 @@ "operationId": "repos/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repositories-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repositories-for-a-user" }, "parameters": [ { @@ -64514,14 +66755,14 @@ "/users/{username}/site_admin": { "put": { "summary": "Promote a user to be a site administrator", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "operationId": "enterprise-admin/promote-user-to-be-site-administrator", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator" }, "parameters": [ { @@ -64550,7 +66791,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#demote-a-site-administrator" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#demote-a-site-administrator" }, "parameters": [ { @@ -64581,7 +66822,7 @@ "operationId": "users/list-social-accounts-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/social-accounts#list-social-accounts-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/social-accounts#list-social-accounts-for-a-user" }, "parameters": [ { @@ -64638,7 +66879,7 @@ "operationId": "users/list-ssh-signing-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" }, "parameters": [ { @@ -64688,14 +66929,14 @@ "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", - "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/starring#list-repositories-starred-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/starring#list-repositories-starred-by-a-user" }, "parameters": [ { @@ -64768,7 +67009,7 @@ "operationId": "activity/list-repos-watched-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/activity/watching#list-repositories-watched-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/activity/watching#list-repositories-watched-by-a-user" }, "parameters": [ { @@ -64818,14 +67059,14 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#suspend-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#suspend-a-user" }, "parameters": [ { @@ -64847,7 +67088,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } }, @@ -64871,14 +67112,14 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#unsuspend-a-user" + "url": "https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#unsuspend-a-user" }, "parameters": [ { @@ -64899,7 +67140,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } }, @@ -64932,7 +67173,7 @@ "operationId": "meta/get-zen", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.11/rest/meta/meta#get-the-zen-of-github" + "url": "https://docs.github.com/enterprise-server@3.13/rest/meta/meta#get-the-zen-of-github" }, "responses": { "200": { @@ -65035,16 +67276,68 @@ }, "x-octokit": {} } + }, + "/orgs/{org}/organization-fine-grained-permissions": { + "get": { + "summary": "List organization fine-grained permissions for an organization", + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-organization-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-fine-grained-permission" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-fine-grained-permission-example" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } } }, "x-webhooks": { "branch-protection-configuration-disabled": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection)\" 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 a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.13/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection)\" 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": "All branch protections were disabled for a repository.", "operationId": "branch-protection-configuration/disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -65133,11 +67426,11 @@ }, "branch-protection-configuration-enabled": { "post": { - "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection)\" 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 a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.13/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection)\" 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": "All branch protections were enabled for a repository.", "operationId": "branch-protection-configuration/enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#branch_protection_configuration" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -65226,11 +67519,11 @@ }, "branch-protection-rule-created": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection)\" 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 branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.13/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection)\" 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 branch protection rule was created.", "operationId": "branch-protection-rule/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -65335,11 +67628,11 @@ }, "branch-protection-rule-deleted": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection)\" 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 branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.13/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection)\" 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 branch protection rule was deleted.", "operationId": "branch-protection-rule/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -65444,11 +67737,11 @@ }, "branch-protection-rule-edited": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection)\" 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 branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.13/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection)\" 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 branch protection rule was edited.", "operationId": "branch-protection-rule/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -65553,10 +67846,10 @@ }, "cache-sync": { "post": { - "summary": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"[About repository caching](https://docs.github.com/enterprise-server@3.11/admin/enterprise-management/caching-repositories/about-repository-caching).\"", + "summary": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"[About repository caching](https://docs.github.com/enterprise-server@3.13/admin/enterprise-management/caching-repositories/about-repository-caching).\"", "operationId": "cache-sync", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#cache_sync" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#cache_sync" }, "parameters": [ { @@ -65661,11 +67954,11 @@ }, "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.11/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.13/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", "operationId": "check-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -65786,11 +68079,11 @@ }, "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.11/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.13/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", "operationId": "check-run/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -65911,11 +68204,11 @@ }, "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.11/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.11/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.13/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.13/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -66036,11 +68329,11 @@ }, "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.11/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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`.", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.13/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -66161,11 +68454,11 @@ }, "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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`.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.13/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -66270,11 +68563,11 @@ }, "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.11/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.13/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.13/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.13/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -66379,11 +68672,11 @@ }, "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.11/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.13/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.13/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -66488,11 +68781,11 @@ }, "code-scanning-alert-appeared-in-branch": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.11/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.13/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -66597,11 +68890,11 @@ }, "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.11/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.13/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "Someone closed a code scanning alert.", "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -66706,11 +68999,11 @@ }, "code-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.11/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.13/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A code scanning alert was created in a repository.", "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -66815,11 +69108,11 @@ }, "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.11/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.13/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A code scanning alert was fixed in a branch by a commit.", "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -66924,11 +69217,11 @@ }, "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.11/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.13/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "A previously fixed code scanning alert reappeared in a branch.", "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -67033,11 +69326,11 @@ }, "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.11/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.13/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "Someone reopened a code scanning alert.", "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -67142,11 +69435,11 @@ }, "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.11/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.13/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "description": "Someone commented on a commit.", "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -67254,7 +69547,7 @@ "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -67359,10 +69652,10 @@ }, "delete": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -67465,13 +69758,13 @@ } } }, - "dependabot-alert-created": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67552,7 +69845,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -67574,13 +69867,13 @@ } } }, - "dependabot-alert-dismissed": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67661,7 +69954,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -67683,13 +69976,13 @@ } } }, - "dependabot-alert-fixed": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67770,7 +70063,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -67792,13 +70085,13 @@ } } }, - "dependabot-alert-reintroduced": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67879,7 +70172,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -67901,13 +70194,13 @@ } } }, - "dependabot-alert-reopened": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.11/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67988,7 +70281,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -68010,13 +70303,13 @@ } } }, - "deploy-key-created": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.11/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.11/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -68097,7 +70390,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -68110,7 +70403,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -68119,13 +70412,13 @@ } } }, - "deploy-key-deleted": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.11/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.11/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -68206,7 +70499,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -68219,7 +70512,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -68228,13 +70521,13 @@ } } }, - "deployment-created": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.11/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.13/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.13/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -68315,7 +70608,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -68328,7 +70621,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -68337,13 +70630,231 @@ } } }, - "deployment-protection-rule-requested": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-server@3.11/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.13/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.13/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deploy_key" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deploy-key-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deploy_key", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deployment-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.13/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deployment" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deployment-protection-rule-requested": { + "post": { + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-server@3.13/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -68446,11 +70957,11 @@ }, "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.11/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.13/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was approved.", "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -68553,11 +71064,11 @@ }, "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.11/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.13/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was rejected.", "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -68660,11 +71171,11 @@ }, "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.11/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.13/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment review was requested.", "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -68767,11 +71278,11 @@ }, "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.11/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.13/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", "description": "A new deployment status was created.", "operationId": "deployment-status/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#deployment_status" }, "parameters": [ { @@ -68876,11 +71387,11 @@ }, "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was marked as the answer.", "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -68985,11 +71496,11 @@ }, "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The category of a discussion was changed.", "operationId": "discussion/category-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69094,11 +71605,11 @@ }, "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was closed.", "operationId": "discussion/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69203,11 +71714,11 @@ }, "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was created.", "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -69312,11 +71823,11 @@ }, "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was deleted.", "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -69421,11 +71932,11 @@ }, "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was edited.", "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -69530,11 +72041,11 @@ }, "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was created.", "operationId": "discussion/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69639,11 +72150,11 @@ }, "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was deleted.", "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69748,11 +72259,11 @@ }, "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", "operationId": "discussion/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69857,11 +72368,11 @@ }, "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was added to a discussion.", "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69966,11 +72477,11 @@ }, "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was locked.", "operationId": "discussion/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70075,11 +72586,11 @@ }, "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was pinned.", "operationId": "discussion/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70184,11 +72695,11 @@ }, "discussion-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was reopened.", "operationId": "discussion/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70293,11 +72804,11 @@ }, "discussion-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was transferred to another repository.", "operationId": "discussion/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70402,11 +72913,11 @@ }, "discussion-unanswered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on the discussion was unmarked as the answer.", "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70511,11 +73022,11 @@ }, "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was removed from a discussion.", "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70620,11 +73131,11 @@ }, "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unlocked.", "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70729,11 +73240,11 @@ }, "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.11/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.13/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unpinned.", "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70838,11 +73349,11 @@ }, "enterprise-anonymous-access-disabled": { "post": { - "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", + "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", "description": "Anonymous Git read access was disabled.", "operationId": "enterprise/anonymous-access-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#enterprise" }, "parameters": [ { @@ -70945,11 +73456,11 @@ }, "enterprise-anonymous-access-enabled": { "post": { - "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", + "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", "description": "Anonymous Git read access was enabled.", "operationId": "enterprise/anonymous-access-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#enterprise" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#enterprise" }, "parameters": [ { @@ -71052,10 +73563,10 @@ }, "fork": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-server@3.11/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-server@3.11/rest/repos/forks)\" 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.", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-server@3.13/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-server@3.13/rest/repos/forks)\" 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.", "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -71161,11 +73672,11 @@ }, "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.13/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", "description": "Someone revoked their authorization of a GitHub App.", "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -71268,10 +73779,10 @@ }, "gollum": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-server@3.11/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-server@3.13/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -71376,11 +73887,11 @@ }, "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "Someone installed a GitHub App on a user or organization account.", "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -71483,11 +73994,11 @@ }, "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "Someone uninstalled a GitHub App from their user or organization account.", "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -71590,11 +74101,11 @@ }, "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "Someone granted new permissions to a GitHub App.", "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -71697,11 +74208,11 @@ }, "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "A GitHub App installation was granted access to one or more repositories.", "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -71804,11 +74315,11 @@ }, "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "Access to one or more repositories was revoked for a GitHub App installation.", "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -71911,11 +74422,11 @@ }, "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "Someone blocked access by a GitHub App to their user or organization account.", "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -72018,11 +74529,11 @@ }, "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -72125,11 +74636,11 @@ }, "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.11/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.11/rest/apps)\" in the REST API documentation.", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.13/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.13/rest/apps)\" in the REST API documentation.", "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -72232,11 +74743,11 @@ }, "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.11/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.11/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.13/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.13/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was created.", "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -72341,11 +74852,11 @@ }, "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.11/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.11/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.13/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.13/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was deleted.", "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -72450,11 +74961,11 @@ }, "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.11/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.11/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.13/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.13/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A comment on an issue or pull request was edited.", "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -72559,11 +75070,11 @@ }, "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was assigned to a user.", "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72668,11 +75179,11 @@ }, "issues-closed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was closed.", "operationId": "issues/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72777,11 +75288,11 @@ }, "issues-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was deleted.", "operationId": "issues/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72886,11 +75397,11 @@ }, "issues-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was removed from a milestone.", "operationId": "issues/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72995,11 +75506,11 @@ }, "issues-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "The title or body on an issue was edited.", "operationId": "issues/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73104,11 +75615,11 @@ }, "issues-labeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A label was added to an issue.", "operationId": "issues/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73213,11 +75724,11 @@ }, "issues-locked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.11/communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73322,11 +75833,11 @@ }, "issues-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was added to a milestone.", "operationId": "issues/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73431,11 +75942,11 @@ }, "issues-opened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", "operationId": "issues/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73540,11 +76051,11 @@ }, "issues-pinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73649,11 +76160,11 @@ }, "issues-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A closed issue was reopened.", "operationId": "issues/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73758,11 +76269,11 @@ }, "issues-transferred": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", "operationId": "issues/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73867,11 +76378,11 @@ }, "issues-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A user was unassigned from an issue.", "operationId": "issues/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73976,11 +76487,11 @@ }, "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "A label was removed from an issue.", "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -74085,11 +76596,11 @@ }, "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.11/communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -74194,11 +76705,11 @@ }, "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.11/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.11/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.13/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.13/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -74303,11 +76814,11 @@ }, "label-created": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.11/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.13/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was created.", "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -74412,11 +76923,11 @@ }, "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.11/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.13/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was deleted.", "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -74521,11 +77032,11 @@ }, "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.11/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.13/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label's name, description, or color was changed.", "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -74630,11 +77141,11 @@ }, "member-added": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A GitHub user accepted an invitation to a repository.", "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -74740,11 +77251,11 @@ }, "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "Permissions were changed for a collaborator on a repository.", "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -74850,11 +77361,11 @@ }, "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.11/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.13/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A collaborator was removed from a repository.", "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -74960,11 +77471,11 @@ }, "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.11/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.11/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.13/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.13/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization member was added to a team.", "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -75069,11 +77580,11 @@ }, "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.11/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.11/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.13/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.13/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization member was removed from a team.", "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -75182,7 +77693,7 @@ "description": "The webhook was deleted.", "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -75289,11 +77800,11 @@ }, "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.11/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.13/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was closed.", "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -75398,11 +77909,11 @@ }, "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.11/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.13/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was created.", "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -75507,11 +78018,11 @@ }, "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.11/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.13/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was deleted.", "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -75616,11 +78127,11 @@ }, "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.11/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.13/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was edited.", "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -75725,11 +78236,11 @@ }, "milestone-opened": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.11/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.11/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.13/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.13/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", "description": "A milestone was opened.", "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -75834,11 +78345,11 @@ }, "organization-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.11/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.11/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.13/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "An organization was deleted.", "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -75943,11 +78454,11 @@ }, "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.11/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.11/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.13/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member accepted an invitation to join an organization.", "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -76052,11 +78563,11 @@ }, "organization-member-invited": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.11/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.11/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.13/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member was invited to join the organization.", "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -76161,11 +78672,11 @@ }, "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.11/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.11/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.13/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "A member was removed from the organization.", "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -76270,11 +78781,11 @@ }, "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.11/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.11/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.13/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", "description": "The name of an organization was changed.", "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -76379,11 +78890,11 @@ }, "package-published": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.11/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.13/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", "description": "A package was published to a registry.", "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -76488,11 +78999,11 @@ }, "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.11/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.13/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", "description": "A previously published package was updated.", "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -76597,10 +79108,10 @@ }, "page-build": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.11/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-server@3.11/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.13/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-server@3.13/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -76705,11 +79216,11 @@ }, "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.11/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.13/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was approved.", "operationId": "personal-access-token-request/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -76796,11 +79307,11 @@ }, "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.11/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.13/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was cancelled by the requester.", "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -76887,11 +79398,11 @@ }, "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.11/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.13/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was created.", "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -76978,11 +79489,11 @@ }, "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.11/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.13/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", "description": "A fine-grained personal access token request was denied.", "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -77072,7 +79583,7 @@ "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -77195,11 +79706,11 @@ }, "project-card-converted": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A note in a project (classic) was converted to an issue.", "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -77304,11 +79815,11 @@ }, "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card was added to a project (classic).", "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -77413,11 +79924,11 @@ }, "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card on a project (classic) was deleted.", "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -77522,11 +80033,11 @@ }, "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A note on a project (classic) was edited.", "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -77631,11 +80142,11 @@ }, "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A card on a project (classic) was moved to another column or to another position in its column.", "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -77740,11 +80251,11 @@ }, "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was closed.", "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -77849,11 +80360,11 @@ }, "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was added to a project (classic).", "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -77958,11 +80469,11 @@ }, "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was deleted from a project (classic).", "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -78067,11 +80578,11 @@ }, "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "The name of a column on a project (classic) was changed.", "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -78176,11 +80687,11 @@ }, "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A column was moved to a new position on a project (classic).", "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -78285,11 +80796,11 @@ }, "project-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was created.", "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -78394,11 +80905,11 @@ }, "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was deleted.", "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -78503,11 +81014,11 @@ }, "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "The name or description of a project (classic) was changed.", "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -78612,11 +81123,11 @@ }, "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.11/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.11/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.13/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.13/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", "description": "A project (classic) was closed.", "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -78721,11 +81232,11 @@ }, "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was closed.", "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -78829,11 +81340,11 @@ }, "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was created.", "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -78937,11 +81448,11 @@ }, "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was deleted.", "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -79045,11 +81556,11 @@ }, "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The title, description, or README of a project in the organization was changed.", "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -79153,11 +81664,11 @@ }, "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79261,11 +81772,11 @@ }, "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A draft issue in an organization project was converted to an issue.", "operationId": "projects-v2-item/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79369,11 +81880,11 @@ }, "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was added to a project in the organization.", "operationId": "projects-v2-item/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79477,11 +81988,11 @@ }, "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "An item was deleted from a project in the organization.", "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79585,11 +82096,11 @@ }, "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79693,11 +82204,11 @@ }, "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79801,11 +82312,11 @@ }, "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79909,11 +82420,11 @@ }, "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.11/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.13/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A project in the organization was reopened.", "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -80017,10 +82528,10 @@ }, "public": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -80125,11 +82636,11 @@ }, "pull-request-assigned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was assigned to a user.", "operationId": "pull-request/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80234,11 +82745,11 @@ }, "pull-request-auto-merge-disabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80343,11 +82854,11 @@ }, "pull-request-auto-merge-enabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", "operationId": "pull-request/auto-merge-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80452,11 +82963,11 @@ }, "pull-request-closed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", "operationId": "pull-request/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80561,11 +83072,11 @@ }, "pull-request-converted-to-draft": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/converted-to-draft", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80670,11 +83181,11 @@ }, "pull-request-demilestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was removed from a milestone.", "operationId": "pull-request/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80779,11 +83290,11 @@ }, "pull-request-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", "operationId": "pull-request/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80888,11 +83399,11 @@ }, "pull-request-labeled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A label was added to a pull request.", "operationId": "pull-request/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80997,11 +83508,11 @@ }, "pull-request-locked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.11/communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81106,11 +83617,11 @@ }, "pull-request-milestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was added to a milestone.", "operationId": "pull-request/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81215,11 +83726,11 @@ }, "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request was created", "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81324,11 +83835,11 @@ }, "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81433,11 +83944,11 @@ }, "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A previously closed pull request was reopened.", "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81542,11 +84053,11 @@ }, "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment on a pull request diff was created.", "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81651,11 +84162,11 @@ }, "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment on a pull request diff was deleted.", "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81760,11 +84271,11 @@ }, "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The content of a comment on a pull request diff was changed.", "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81869,11 +84380,11 @@ }, "pull-request-review-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A review on a pull request was dismissed.", "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -81978,11 +84489,11 @@ }, "pull-request-review-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "The body comment on a pull request review was edited.", "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -82087,11 +84598,11 @@ }, "pull-request-review-request-removed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A request for review by a person or team was removed from a pull request.", "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82196,11 +84707,11 @@ }, "pull-request-review-requested": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", "operationId": "pull-request/review-requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82305,11 +84816,11 @@ }, "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A review on a pull request was submitted.", "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -82414,11 +84925,11 @@ }, "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A comment thread on a pull request was marked as resolved.", "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -82523,11 +85034,11 @@ }, "pull-request-review-thread-unresolved": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A previously resolved comment thread on a pull request was marked as unresolved.", "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -82632,11 +85143,11 @@ }, "pull-request-synchronize": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", "operationId": "pull-request/synchronize", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82741,11 +85252,11 @@ }, "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A user was unassigned from a pull request.", "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82850,11 +85361,11 @@ }, "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", "description": "A label was removed from a pull request.", "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82959,11 +85470,11 @@ }, "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.11/communities/moderating-comments-and-conversations/locking-conversations).\"", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -83068,10 +85579,10 @@ }, "push": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -83176,11 +85687,11 @@ }, "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.11/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.13/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package was published to a registry.", "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -83285,11 +85796,11 @@ }, "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.11/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.13/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", "description": "A package that was previously published to a registry was updated.", "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -83394,11 +85905,11 @@ }, "release-created": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.11/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-server@3.11/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.13/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-server@3.13/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.13/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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", "operationId": "release/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83503,11 +86014,11 @@ }, "release-deleted": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.11/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-server@3.11/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.13/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-server@3.13/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.13/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 release was deleted.", "operationId": "release/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83612,11 +86123,11 @@ }, "release-edited": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.11/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-server@3.11/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.11/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-server@3.11/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.13/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-server@3.13/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.13/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-server@3.13/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", "operationId": "release/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83721,11 +86232,11 @@ }, "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-server@3.11/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-server@3.11/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.13/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-server@3.13/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83830,11 +86341,11 @@ }, "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-server@3.11/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-server@3.11/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.13/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-server@3.13/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83939,11 +86450,11 @@ }, "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-server@3.11/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-server@3.11/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.13/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-server@3.13/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -84048,11 +86559,11 @@ }, "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-server@3.11/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-server@3.11/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.13/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-server@3.13/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -84157,11 +86668,11 @@ }, "repository-anonymous-access-disabled": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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": "Someone disabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", "operationId": "repository/anonymous-access-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84267,11 +86778,11 @@ }, "repository-anonymous-access-enabled": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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": "Someone enabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", "operationId": "repository/anonymous-access-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84377,11 +86888,11 @@ }, "repository-archived": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84487,11 +86998,11 @@ }, "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-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84597,11 +87108,11 @@ }, "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-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84707,10 +87218,10 @@ }, "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-server@3.11/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "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-server@3.13/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -84813,11 +87324,11 @@ }, "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-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84923,11 +87434,11 @@ }, "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-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -85033,11 +87544,11 @@ }, "repository-publicized": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -85143,11 +87654,11 @@ }, "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-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -85253,11 +87764,11 @@ }, "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/enterprise-server@3.11/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-server@3.11/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.11/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.11/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.", + "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-server@3.13/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-server@3.13/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.13/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -85346,11 +87857,11 @@ }, "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/enterprise-server@3.11/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-server@3.11/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.11/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.11/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.", + "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-server@3.13/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-server@3.13/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.13/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -85439,11 +87950,11 @@ }, "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-server@3.11/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-server@3.11/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.11/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.11/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.", + "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-server@3.13/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-server@3.13/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.13/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -85532,11 +88043,11 @@ }, "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -85642,11 +88153,11 @@ }, "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.11/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.11/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -85752,11 +88263,11 @@ }, "repository-vulnerability-alert-create": { "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-server@3.11/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85860,11 +88371,11 @@ }, "repository-vulnerability-alert-dismiss": { "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-server@3.11/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85968,11 +88479,11 @@ }, "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -86076,11 +88587,11 @@ }, "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A repository vulnerability alert was marked as resolved.", "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -86184,11 +88695,11 @@ }, "secret-scanning-alert-created": { "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-server@3.11/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-server@3.11/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.", + "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-server@3.13/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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86293,11 +88804,11 @@ }, "secret-scanning-alert-location-created": { "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-server@3.11/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-server@3.11/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.", + "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-server@3.13/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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -86418,11 +88929,11 @@ }, "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-server@3.11/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-server@3.11/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.", + "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-server@3.13/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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86527,11 +89038,11 @@ }, "secret-scanning-alert-resolved": { "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-server@3.11/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-server@3.11/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.", + "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-server@3.13/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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86634,13 +89145,13 @@ } } }, - "secret-scanning-alert-revoked": { + "secret-scanning-alert-validated": { "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-server@3.11/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-server@3.11/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 secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.13/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-server@3.13/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 validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86721,7 +89232,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -86745,11 +89256,11 @@ }, "security-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.11/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/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-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.13/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.13/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -86852,11 +89363,11 @@ }, "security-advisory-updated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.11/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/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-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.13/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.13/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "The metadata or description of a security advisory was changed.", "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -86959,11 +89470,11 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.11/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/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-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.13/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.13/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -87066,10 +89577,10 @@ }, "security-and-analysis": { "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-server@3.11/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.", + "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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -87174,11 +89685,11 @@ }, "sponsorship-cancelled": { "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-server@3.11/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-server@3.11/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-server@3.11/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.13/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-server@3.13/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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87281,11 +89792,11 @@ }, "sponsorship-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-server@3.11/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-server@3.11/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-server@3.11/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.13/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-server@3.13/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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87388,11 +89899,11 @@ }, "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-server@3.11/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-server@3.11/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-server@3.11/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.13/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-server@3.13/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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87495,11 +90006,11 @@ }, "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-server@3.11/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-server@3.11/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-server@3.11/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.13/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-server@3.13/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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87602,11 +90113,11 @@ }, "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-server@3.11/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-server@3.11/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-server@3.11/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.13/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-server@3.13/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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87709,11 +90220,11 @@ }, "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-server@3.11/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-server@3.11/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-server@3.11/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.13/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-server@3.13/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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87816,11 +90327,11 @@ }, "star-created": { "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-server@3.11/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-server@3.11/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.11/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.", + "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-server@3.13/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-server@3.13/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -87925,11 +90436,11 @@ }, "star-deleted": { "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-server@3.11/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-server@3.11/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.11/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.", + "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-server@3.13/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-server@3.13/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -88034,10 +90545,10 @@ }, "status": { "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-server@3.11/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-server@3.11/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-server@3.11/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.", + "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-server@3.13/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-server@3.13/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -88142,10 +90653,10 @@ }, "team-add": { "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-server@3.11/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.", + "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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -88250,11 +90761,11 @@ }, "team-added-to-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-server@3.11/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.", + "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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -88359,11 +90870,11 @@ }, "team-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-server@3.11/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.", + "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-server@3.13/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-server@3.11/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -88468,11 +90979,11 @@ }, "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-server@3.11/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.", + "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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -88577,11 +91088,11 @@ }, "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-server@3.11/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.", + "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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -88686,11 +91197,11 @@ }, "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-server@3.11/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.", + "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-server@3.13/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -88799,7 +91310,7 @@ "description": "A user account was added to the enterprise.", "operationId": "user/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#user" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#user" }, "parameters": [ { @@ -88906,7 +91417,7 @@ "description": "A user account was removed from the enterprise.", "operationId": "user/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#user" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#user" }, "parameters": [ { @@ -89009,11 +91520,11 @@ }, "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-server@3.11/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-server@3.11/rest/activity/watching)\" 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.", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-server@3.13/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-server@3.13/rest/activity/watching)\" 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 started watching the repository.", "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -89118,10 +91629,10 @@ }, "workflow-dispatch": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-server@3.11/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-server@3.13/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -89224,11 +91735,11 @@ }, "workflow-job-completed": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.11/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", "operationId": "workflow-job/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -89334,11 +91845,11 @@ }, "workflow-job-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.11/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run started processing on a runner.", "operationId": "workflow-job/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -89444,11 +91955,11 @@ }, "workflow-job-queued": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.11/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created.", "operationId": "workflow-job/queued", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -89554,11 +92065,11 @@ }, "workflow-job-waiting": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.11/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created and is waiting for approvals.", "operationId": "workflow-job/waiting", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -89664,11 +92175,11 @@ }, "workflow-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.11/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.13/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", "operationId": "workflow-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -89774,11 +92285,11 @@ }, "workflow-run-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.11/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.13/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run started processing on a runner.", "operationId": "workflow-run/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -89884,11 +92395,11 @@ }, "workflow-run-requested": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.11/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.11/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.13/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run was triggered.", "operationId": "workflow-run/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -90271,7 +92782,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "key": { "type": "string" @@ -90282,7 +92794,8 @@ }, "repository_id": { "nullable": true, - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -90385,6 +92898,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -90579,6 +93093,10 @@ }, "business_plus": { "type": "boolean" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -90698,7 +93216,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -90797,7 +93316,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -90865,6 +93385,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -90942,6 +93463,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -91075,6 +93600,14 @@ "write" ] }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -91171,9 +93704,26 @@ "write" ] }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, "organization_copilot_seat_management": { "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] @@ -91226,7 +93776,7 @@ }, "organization_projects": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", @@ -91355,6 +93905,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -91432,6 +93983,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -91513,7 +94068,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -91676,6 +94232,58 @@ "vulnerable_functions" ] }, + "cvss-severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, "security-advisory-credit-types": { "type": "string", "description": "The type of credit the user is receiving.", @@ -91861,6 +94469,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "nullable": true, @@ -91883,6 +94494,18 @@ ] } }, + "epss": { + "type": "object", + "nullable": true, + "properties": { + "percentage": { + "type": "number" + }, + "percentile": { + "type": "number" + } + } + }, "credits": { "type": "array", "description": "In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available.", @@ -92069,10 +94692,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -92114,7 +94733,7 @@ }, "webhook-config-secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "webhook-config-insecure-ssl": { @@ -92211,6 +94830,13 @@ "type": "integer", "example": 123, "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true } }, "required": [ @@ -92385,6 +95011,13 @@ "example": 123, "nullable": true }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + }, "url": { "description": "The URL target of the delivery.", "type": "string", @@ -92737,7 +95370,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -93138,7 +95772,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -93343,6 +95977,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "url": { @@ -93439,7 +96074,7 @@ }, "announcement-message": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.11/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.13/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -94371,6 +97006,7 @@ "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", + "nullable": true, "enum": [ "open", "dismissed", @@ -94396,7 +97032,6 @@ "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "nullable": true, "enum": [ - null, "false positive", "won't fix", "used in tests" @@ -94420,14 +97055,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "nullable": true, "type": "string", @@ -94453,6 +97080,14 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -94574,6 +97209,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, @@ -94941,6 +97577,11 @@ "example": false, "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise." }, + "advanced_security_enabled_for_new_user_namespace_repositories": { + "type": "boolean", + "example": false, + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories." + }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, @@ -95113,6 +97754,9 @@ ], "additionalProperties": false }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "description": "Details for the advisory pertaining to Common Weakness Enumeration.", @@ -95421,7 +98065,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -95448,6 +98092,15 @@ "type": "string", "description": "The comment that was optionally added when this alert was closed", "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } }, @@ -95460,11 +98113,16 @@ "last_pushed_date": { "type": "string", "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" } }, "required": [ "user_login", - "last_pushed_date" + "last_pushed_date", + "last_pushed_email" ] }, "advanced-security-active-committers-repository": { @@ -95502,6 +98160,16 @@ "type": "integer", "example": 2 }, + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" + }, + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" + }, "repositories": { "type": "array", "items": { @@ -95752,10 +98420,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -95849,6 +98513,26 @@ "rocket" ] }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -96065,6 +98749,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -96436,6 +99123,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -96508,7 +99200,11 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" }, "node_id": { "type": "string" @@ -96588,6 +99284,11 @@ "format": "email", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -96643,11 +99344,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "private_gists": { "type": "integer", "example": 1 @@ -96948,6 +99644,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -97237,6 +99938,326 @@ "featured" ] }, + "ghes-get-ssh": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "format": "ssh-key", + "description": "The full public key" + }, + "fingerprint": { + "type": "string", + "format": "ssh-key fingerprint", + "description": "The fingerprint of the key" + } + } + } + }, + "ghes-set-ssh-request": { + "title": "Set SSH key", + "type": "object", + "properties": { + "key": { + "description": "The public SSH key to add to the `authorized_keys` file.", + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "ghes-set-ssh-response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname", + "description": "Hostname of the node where the SSH key was added." + }, + "uuid": { + "type": "string", + "format": "uuid", + "description": "UUID of the SSH key that was added." + }, + "message": { + "type": "string", + "description": "Message indicating the result of the SSH key addition." + }, + "error": { + "type": "string", + "description": "Error message indicating the reason for the SSH key addition failure. This field is only present if the SSH key addition failed." + }, + "modified": { + "type": "boolean", + "description": "Whether the SSH key was already present on the `authorized_keys` file." + } + } + } + }, + "ghes-delete-ssh-request": { + "title": "Set SSH key", + "type": "object", + "properties": { + "key": { + "description": "The public SSH key to remove from the `authorized_keys` file.", + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "ghes-delete-ssh-response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname", + "description": "Hostname of the node where the SSH key was removed." + }, + "uuid": { + "type": "string", + "format": "uuid", + "description": "UUID of the SSH key that was removed." + }, + "message": { + "type": "string", + "description": "Message indicating the result of the SSH key removal." + }, + "error": { + "type": "string", + "description": "Error message indicating the reason for the SSH key removal failure. This field is only present if the SSH key removal failed." + } + } + } + }, + "ghes-checks-result-indicator": { + "type": "string", + "enum": [ + "OK", + "FAILED" + ] + }, + "ghes-checks-system-requirements": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "roles_status": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "role": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "ghes-cluster-status-indicator": { + "type": "string", + "enum": [ + "UNKNOWN", + "OK", + "WARNING", + "CRITICAL" + ] + }, + "ghes-cluster-status": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "name": { + "type": "string" + }, + "details": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "ghes-config-init-request": { + "title": "Initialize configuration with license upload", + "type": "object", + "properties": { + "license": { + "type": "string", + "description": "The content of your _.ghl_ license file." + }, + "password": { + "type": "string", + "description": "The root site administrator password." + } + }, + "required": [ + "license", + "password" + ] + }, + "ghes-license-info": { + "type": "object", + "properties": { + "advancedSecurityEnabled": { + "description": "Whether the GitHub Advanced Security feature is enabled.", + "type": "boolean" + }, + "advancedSecuritySeats": { + "description": "If the GitHub Advanced Security feature is enabled, the seat count.", + "type": "integer" + }, + "clusterSupport": { + "description": "Whether the cluster support feature is enabled.", + "type": "boolean" + }, + "company": { + "description": "The company under which the license is issued.", + "type": "string" + }, + "croquetSupport": { + "description": "Whether the Github Connect feature is enabled.", + "type": "boolean" + }, + "customTerms": { + "description": "Whether this license is issued under custom terms.", + "type": "boolean" + }, + "evaluation": { + "description": "Wheter this license is issued as an evaluation license.", + "type": "boolean" + }, + "expireAt": { + "description": "The expiration date of the license.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "insightsEnabled": { + "description": "Whether the insights feature is enabled.", + "type": "boolean" + }, + "insightsExpireAt": { + "description": "If the insights feature is enabled, the expiration date.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "learningLabEvaluationExpires": { + "description": "If the learning lab feature is enabled, the expiration date.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "learningLabSeats": { + "description": "If the learning lab feature is enabled, the seat count.", + "type": "integer" + }, + "perpetual": { + "description": "Whether the perpetual feature is enabled.", + "type": "boolean" + }, + "referenceNumber": { + "description": "The unique reference number of the license.", + "type": "string" + }, + "seats": { + "description": "If the license is issued with limited seating, the seat count.", + "type": "integer" + }, + "sshAllowed": { + "description": "Whether the SSH feature is enabled.", + "type": "boolean" + }, + "supportKey": { + "description": "The support key of the license.", + "type": "string" + }, + "unlimitedSeating": { + "description": "Whether the license is issued with unlimited seat count.", + "type": "boolean" + } + } + }, + "ghes-upload-license-request": { + "title": "License upload form", + "type": "object", + "properties": { + "license": { + "type": "string", + "description": "The content of your _.ghl_ license file." + } + }, + "required": [ + "license" + ] + }, + "ghes-license-check": { + "type": "object", + "properties": { + "status": { + "description": "The license status of the currently active enterprise license.", + "type": "string", + "enum": [ + "valid", + "invalid", + "expired", + "cluster mode not supported" + ] + } + } + }, "ghes-cluster-topology": { "type": "string", "enum": [ @@ -97296,6 +100317,428 @@ } } }, + "ghes-get-settings": { + "type": "object", + "properties": { + "private_mode": { + "type": "boolean" + }, + "public_pages": { + "type": "boolean" + }, + "subdomain_isolation": { + "type": "boolean" + }, + "signup_enabled": { + "type": "boolean" + }, + "github_hostname": { + "type": "string" + }, + "identicons_host": { + "type": "string" + }, + "http_proxy": { + "nullable": true, + "type": "string" + }, + "auth_mode": { + "type": "string" + }, + "expire_sessions": { + "type": "boolean" + }, + "admin_password": { + "nullable": true, + "type": "string" + }, + "configuration_id": { + "type": "integer" + }, + "configuration_run_count": { + "type": "integer" + }, + "avatar": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "uri": { + "type": "string" + } + } + }, + "customer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "secret_key_data": { + "type": "string" + }, + "public_key_data": { + "type": "string" + } + } + }, + "license": { + "type": "object", + "properties": { + "seats": { + "type": "integer" + }, + "evaluation": { + "type": "boolean" + }, + "perpetual": { + "type": "boolean" + }, + "unlimited_seating": { + "type": "boolean" + }, + "support_key": { + "type": "string" + }, + "ssh_allowed": { + "type": "boolean" + }, + "cluster_support": { + "type": "boolean" + }, + "expire_at": { + "type": "string" + } + } + }, + "github_ssl": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "cert": { + "nullable": true, + "type": "string" + }, + "key": { + "nullable": true, + "type": "string" + } + } + }, + "ldap": { + "type": "object", + "properties": { + "host": { + "nullable": true, + "type": "string" + }, + "port": { + "type": "integer" + }, + "base": { + "type": "array", + "items": { + "type": "string" + } + }, + "uid": { + "nullable": true, + "type": "string" + }, + "bind_dn": { + "nullable": true, + "type": "string" + }, + "password": { + "nullable": true, + "type": "string" + }, + "method": { + "type": "string" + }, + "search_strategy": { + "type": "string" + }, + "user_groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "admin_group": { + "nullable": true, + "type": "string" + }, + "virtual_attribute_enabled": { + "type": "boolean" + }, + "recursive_group_search": { + "type": "boolean" + }, + "posix_support": { + "type": "boolean" + }, + "user_sync_emails": { + "type": "boolean" + }, + "user_sync_keys": { + "type": "boolean" + }, + "user_sync_interval": { + "type": "integer" + }, + "team_sync_interval": { + "type": "integer" + }, + "sync_enabled": { + "type": "boolean" + }, + "reconciliation": { + "type": "object", + "properties": { + "user": { + "nullable": true, + "type": "string" + }, + "org": { + "nullable": true, + "type": "string" + } + } + }, + "profile": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, + "mail": { + "nullable": true, + "type": "string" + }, + "key": { + "nullable": true, + "type": "string" + } + } + } + } + }, + "cas": { + "type": "object", + "properties": { + "url": { + "nullable": true, + "type": "string" + } + } + }, + "saml": { + "type": "object", + "properties": { + "sso_url": { + "nullable": true, + "type": "string" + }, + "certificate": { + "nullable": true, + "type": "string" + }, + "certificate_path": { + "nullable": true, + "type": "string" + }, + "issuer": { + "nullable": true, + "type": "string" + }, + "idp_initiated_sso": { + "type": "boolean" + }, + "disable_admin_demote": { + "type": "boolean" + } + } + }, + "github_oauth": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + }, + "organization_name": { + "type": "string" + }, + "organization_team": { + "type": "string" + } + } + }, + "smtp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "address": { + "type": "string" + }, + "authentication": { + "type": "string" + }, + "port": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "username": { + "type": "string" + }, + "user_name": { + "type": "string" + }, + "enable_starttls_auto": { + "type": "boolean" + }, + "password": { + "type": "string" + }, + "discard-to-noreply-address": { + "type": "boolean" + }, + "support_address": { + "type": "string" + }, + "support_address_type": { + "type": "string" + }, + "noreply_address": { + "type": "string" + } + } + }, + "ntp": { + "type": "object", + "properties": { + "primary_server": { + "type": "string" + }, + "secondary_server": { + "type": "string" + } + } + }, + "timezone": { + "nullable": true, + "type": "string" + }, + "snmp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "community": { + "type": "string" + } + } + }, + "syslog": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "nullable": true, + "type": "string" + }, + "protocol_name": { + "type": "string" + } + } + }, + "assets": { + "nullable": true, + "type": "string" + }, + "pages": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "collectd": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "nullable": true, + "type": "string" + }, + "port": { + "type": "integer" + }, + "encryption": { + "nullable": true, + "type": "string" + }, + "username": { + "nullable": true, + "type": "string" + }, + "password": { + "nullable": true, + "type": "string" + } + } + }, + "mapping": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "tileserver": { + "nullable": true, + "type": "string" + }, + "basemap": { + "type": "string" + }, + "token": { + "nullable": true, + "type": "string" + } + } + }, + "load_balancer": { + "nullable": true, + "type": "string" + } + } + }, "ghes-get-maintenance": { "type": "array", "items": { @@ -97516,15 +100959,6 @@ "192.0.2.1" ] }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -97572,12 +101006,55 @@ "example.com" ] } + }, + "actions_inbound": { + "type": "object", + "properties": { + "full_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "wildcard_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + }, + "artifact_attestations": { + "type": "object", + "properties": { + "trust_domain": { + "type": "string", + "example": [ + "example" + ] + }, + "services": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } } } }, "installed_version": { "type": "string", - "example": "3.11.0" + "example": "3.13.0" } }, "required": [ @@ -97647,6 +101124,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -98383,7 +101861,8 @@ "collaborators": { "type": "integer", "example": 8, - "nullable": true + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", @@ -98475,27 +101954,27 @@ "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -98994,6 +102473,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -99810,6 +103290,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 79 }, "owner": { @@ -100070,6 +103551,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -100093,6 +103582,8 @@ "repositories_url", "permissions", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -100105,7 +103596,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." }, "owner": { "$ref": "#/components/schemas/simple-user" @@ -100151,6 +103642,14 @@ "type": "string", "description": "Date and time when the fine-grained personal access token was approved to access the organization." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -100173,6 +103672,8 @@ "repositories_url", "permissions", "access_granted_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -100295,6 +103796,207 @@ "updated_at" ] }, + "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" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "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": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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" + ] + }, "nullable-repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -100303,7 +104005,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -100704,7 +104407,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -100891,6 +104594,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -101358,6 +105062,11 @@ }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -101457,7 +105166,7 @@ }, "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.", + "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 not available for the `repository` target.", "enum": [ "disabled", "active", @@ -101491,11 +105200,12 @@ }, "bypass_mode": { "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\n", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", "enum": [ "always", "pull_request" - ] + ], + "default": "always" } } }, @@ -101580,10 +105290,69 @@ "repository_id" ] }, + "repository-ruleset-conditions-repository-property-spec": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + }, + "repository-ruleset-conditions-repository-property-target": { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, "org-ruleset-conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\n", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", "oneOf": [ { "type": "object", @@ -101610,6 +105379,19 @@ "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" } ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + } + ] } ] }, @@ -101736,6 +105518,33 @@ } } }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { + "type": "string", + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", @@ -101753,6 +105562,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -101821,6 +105637,10 @@ "parameters": { "type": "object", "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, "required_status_checks": { "type": "array", "description": "Status checks that are required.", @@ -102135,6 +105955,10 @@ "parameters": { "type": "object", "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, "workflows": { "type": "array", "description": "Workflows that must pass for this rule to pass.", @@ -102225,7 +106049,8 @@ "description": "The target of the ruleset.", "enum": [ "branch", - "tag" + "tag", + "push" ] }, "source_type": { @@ -102276,6 +106101,7 @@ }, "html": { "type": "object", + "nullable": true, "properties": { "href": { "type": "string", @@ -102312,6 +106138,188 @@ } } }, + "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.", + "nullable": true + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account.", + "nullable": true + }, + "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", + "nullable": true, + "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`. Null if no rules with `evaluate` enforcement status were run." + }, + "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", + "nullable": true, + "description": "The detailed failure message for the rule. Null if the rule passed." + } + } + } + } + } + }, "team-simple": { "title": "Team Simple", "description": "Groups of organization members that gives permissions on specified repositories.", @@ -103834,7 +107842,8 @@ "id": { "description": "The project card's ID", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -104028,6 +108037,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -104573,7 +108585,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -104594,7 +108607,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -104629,7 +108643,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -105081,8 +109096,9 @@ "properties": { "id": { "description": "The id of the environment.", - "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 56780428 }, "node_id": { "type": "string", @@ -105163,8 +109179,9 @@ }, "id": { "description": "Unique identifier of the deployment", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 42 }, "node_id": { "type": "string", @@ -105650,7 +109667,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -105699,6 +109717,9 @@ }, "site_admin": { "type": "boolean" + }, + "user_view_type": { + "type": "string" } } } @@ -105848,12 +109869,19 @@ "site_admin": { "type": "boolean", "example": false + }, + "user_view_type": { + "type": "string", + "example": "public" } } }, "name": { "type": "string" }, + "client_id": { + "type": "string" + }, "description": { "type": "string" }, @@ -106260,10 +110288,26 @@ ] }, "author": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "committer": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "parents": { "type": "array", @@ -106758,7 +110802,8 @@ "id": { "description": "The id of the check.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "head_sha": { "description": "The SHA of the commit that is being checked.", @@ -107058,7 +111103,8 @@ "properties": { "id": { "type": "integer", - "example": 5 + "example": 5, + "format": "int64" }, "node_id": { "type": "string", @@ -107320,7 +111366,7 @@ }, "full_description": { "type": "string", - "description": "description of the rule used to detect the alert." + "description": "A description of the rule used to detect the alert." }, "tags": { "nullable": true, @@ -107557,6 +111603,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -107621,6 +111668,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -107633,10 +111681,7 @@ } } }, - "additionalProperties": true, - "required": [ - "state" - ] + "additionalProperties": false }, "code-scanning-default-setup-update-response": { "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.", @@ -107659,7 +111704,7 @@ "example": "refs/heads/main" }, "code-scanning-analysis-sarif-file": { - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.11/code-security/secure-coding/sarif-support-for-code-scanning).\"", + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.13/code-security/secure-coding/sarif-support-for-code-scanning).\"", "type": "string" }, "code-scanning-sarifs-receipt": { @@ -107778,6 +111823,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -107888,6 +111934,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -107922,6 +111972,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -108032,6 +112083,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -108241,6 +112296,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -108816,6 +112872,9 @@ "sha": { "type": "string" }, + "content": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -108852,9 +112911,6 @@ "path": { "type": "string" }, - "content": { - "type": "string" - }, "sha": { "type": "string" }, @@ -108951,9 +113007,7 @@ "sha", "size", "type", - "url", - "content", - "encoding" + "url" ] }, "content-directory": { @@ -109463,6 +113517,49 @@ } } }, + "secret-scanning-push-protection-bypass-placeholder-id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "repository-rule-violation-error": { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, "contributor": { "title": "Contributor", "description": "Contributor", @@ -109539,6 +113636,9 @@ }, "name": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -109798,6 +113898,11 @@ "example": "SPDX-2.3", "description": "The version of the SPDX specification that this document conforms to." }, + "comment": { + "type": "string", + "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/", + "description": "An optional comment about the SPDX document." + }, "creationInfo": { "type": "object", "properties": { @@ -109830,17 +113935,9 @@ "example": "CC0-1.0", "description": "The license under which the SPDX document is licensed." }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "example": "github/github" - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", - "example": "https://github.com/example/dependency_graph/sbom-123", + "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "description": "The namespace for the SPDX document." }, "packages": { @@ -109855,7 +113952,7 @@ }, "name": { "type": "string", - "example": "rubygems:github/github", + "example": "github/github", "description": "The name of the package." }, "versionInfo": { @@ -109888,6 +113985,11 @@ "example": "NOASSERTION", "description": "The distribution source of this package, or NOASSERTION if this was not determined." }, + "copyrightText": { + "type": "string", + "example": "Copyright (c) 1985 GitHub.com", + "description": "The copyright holders of the package, and any dates present with those notices, if available." + }, "externalRefs": { "type": "array", "items": { @@ -109923,8 +114025,33 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "example": "DEPENDS_ON", + "description": "The type of relationship between the two SPDX elements." + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -109934,7 +114061,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -110153,6 +114279,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -110190,7 +114317,7 @@ "example": "production" }, "target_url": { - "description": "Deprecated: the URL to associate with this status.", + "description": "Closing down notice: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", @@ -110280,7 +114407,8 @@ "id": { "description": "The id of the environment.", "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -110436,11 +114564,11 @@ }, "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 }, @@ -110449,9 +114577,18 @@ "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" + ] } } }, @@ -110463,6 +114600,15 @@ "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": [ @@ -111105,7 +115251,8 @@ "id": { "description": "Unique identifier of the repository invitation.", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "repository": { "$ref": "#/components/schemas/minimal-repository" @@ -111378,6 +115525,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -112637,6 +116787,7 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 @@ -112657,6 +116808,7 @@ "type": "string" }, "description": { + "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true @@ -112667,6 +116819,7 @@ "type": "string" }, "default": { + "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } @@ -113082,14 +117235,16 @@ }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", - "example": 42, "type": "integer", + "format": "int64", + "example": 42, "nullable": true }, "id": { "description": "The ID of the pull request review comment.", - "example": 1, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { "description": "The node ID of the pull request review comment.", @@ -113107,12 +117262,12 @@ "type": "string" }, "position": { - "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", + "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", "example": 1, "type": "integer" }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", + "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", "example": 4, "type": "integer" }, @@ -114063,11 +118218,22 @@ "description": "The GitHub Pages deployment status.", "type": "object", "properties": { + "id": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit." + }, "status_url": { "type": "string", "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", - "example": "https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251" + "example": "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" }, "page_url": { "type": "string", @@ -114083,10 +118249,34 @@ } }, "required": [ + "id", "status_url", "page_url" ] }, + "pages-deployment-status": { + "title": "GitHub Pages deployment status", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the deployment.", + "enum": [ + "deployment_in_progress", + "syncing_files", + "finished_file_sync", + "updating_pages", + "purging_cdn", + "deployment_cancelled", + "deployment_failed", + "deployment_content_failed", + "deployment_attempt_error", + "deployment_lost", + "succeed" + ] + } + } + }, "repository-pre-receive-hook": { "type": "object", "properties": { @@ -114116,6 +118306,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -114306,596 +118497,13 @@ "type": "string" }, "repo": { - "type": "object", - "nullable": true, - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "spdx_id": { - "type": "string", - "nullable": true - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -114916,567 +118524,13 @@ "type": "string" }, "repo": { - "type": "object", - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -115684,7 +118738,8 @@ "id": { "description": "Unique identifier of the review", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -115788,11 +118843,13 @@ }, "pull_request_review_id": { "type": "integer", + "format": "int64", "example": 42, "nullable": true }, "id": { "type": "integer", + "format": "int64", "example": 10 }, "node_id": { @@ -116385,7 +119442,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -116404,6 +119461,15 @@ "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } }, @@ -116566,7 +119632,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -116581,7 +119647,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -117937,6 +121003,26 @@ } } }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "type": "string" }, @@ -118644,7 +121730,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -118762,6 +121849,9 @@ "type": "string", "format": "date-time", "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -119292,8 +122382,12 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, + "user_view_type": { + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -119392,6 +122486,12 @@ "example": "octocat@github.com", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -119479,11 +122579,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "business_plus": { "type": "boolean" }, @@ -119569,6 +122664,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 3 }, "name": { @@ -119630,7 +122726,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "primary_key_id": { "type": "integer" @@ -119747,7 +122844,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -119886,7 +122984,7 @@ }, "enterprise-webhooks": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts).\"\n", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.13/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -119954,7 +123052,7 @@ }, "simple-installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.13/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -120054,7 +123152,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -120357,6 +123456,11 @@ "type": "string" } }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "has_issues": { "description": "Whether issues are enabled.", "default": true, @@ -120822,7 +123926,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -120975,128 +124079,9 @@ "updated_at" ] }, - "simple-user-webhooks": { - "title": "Simple User", - "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, "webhooks_rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -121249,6 +124234,7 @@ "strict_required_status_checks_policy", "signature_requirement_enforcement_level", "linear_history_requirement_enforcement_level", + "lock_branch_enforcement_level", "admin_enforced", "allow_force_pushes_enforcement_level", "allow_deletions_enforcement_level", @@ -121503,11 +124489,11 @@ "type": "string" }, "webhooks_ref_0": { - "description": "The [`git ref`](https://docs.github.com/enterprise-server@3.11/rest/git/refs#get-a-reference) resource.", + "description": "The [`git ref`](https://docs.github.com/enterprise-server@3.13/rest/git/refs#get-a-reference) resource.", "type": "string" }, "webhooks_deploy_key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-server@3.11/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/enterprise-server@3.13/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { @@ -121661,6 +124647,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -121849,7 +124838,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -121894,6 +124884,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122001,6 +124994,131 @@ "format": "date-time" }, "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", + "format": "int64" + }, + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "answer_chosen_at": { + "type": "string", + "nullable": true + }, + "answer_chosen_by": { "title": "User", "type": "object", "nullable": true, @@ -122085,127 +125203,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body" - ] - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "answer_chosen_at": { - "type": "string", - "nullable": true - }, - "answer_chosen_by": { - "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": { + "user_view_type": { "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": [ @@ -122429,7 +125429,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -122474,12 +125475,21 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ "login", "id" ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } } }, "required": [ @@ -122643,7 +125653,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -122688,6 +125699,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122831,7 +125845,7 @@ }, "webhooks_issue_comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -122935,6 +125949,153 @@ "format": "uri" }, "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", + "format": "int64" + }, + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "webhooks_changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "webhooks_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { "title": "User", "type": "object", "nullable": true, @@ -123020,149 +126181,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "html_url", - "issue_url", - "id", - "node_id", - "user", - "created_at", - "updated_at", - "author_association", - "performed_via_github_app", - "body", - "reactions" - ] - }, - "webhooks_changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, - "webhooks_issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": "string", - "nullable": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "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": { + "user_view_type": { "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", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ @@ -123258,6 +126279,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123472,6 +126496,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123732,6 +126759,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124092,6 +127122,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -124122,6 +127172,145 @@ "format": "uri" }, "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", + "format": "int64" + }, + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "webhooks_milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": "object", "nullable": true, @@ -124207,141 +127396,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - "webhooks_milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "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": { + "user_view_type": { "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", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ @@ -124421,7 +127478,7 @@ }, "webhooks_issue_2": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -124520,6 +127577,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124614,6 +127674,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124827,6 +127890,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125085,6 +128151,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125444,6 +128513,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -125513,7 +128602,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -125558,6 +128648,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125676,6 +128769,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125836,7 +128932,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -126139,6 +129236,11 @@ "type": "string" } }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "has_issues": { "description": "Whether issues are enabled.", "default": true, @@ -126604,7 +129706,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -126860,6 +129962,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126996,7 +130101,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -127041,6 +130147,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127194,6 +130303,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -127219,6 +130336,8 @@ "repository_count", "repositories", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -127336,6 +130455,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127483,6 +130605,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127812,7 +130937,7 @@ ] }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**", "type": "boolean", "default": false } @@ -128043,6 +131168,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128262,6 +131390,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128490,7 +131621,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -128692,6 +131824,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128975,7 +132110,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -129020,6 +132156,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129281,7 +132420,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -129483,6 +132623,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129766,7 +132909,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -129811,6 +132955,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129995,6 +133142,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130106,6 +133256,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130633,7 +133786,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -130679,6 +133833,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130728,7 +133885,7 @@ }, "webhooks_review_comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -130999,7 +134156,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131044,6 +134202,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131206,7 +134367,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131251,6 +134413,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131279,7 +134444,7 @@ }, "webhooks_release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -131533,6 +134698,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131679,7 +134847,7 @@ }, "webhooks_release_1": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -131958,6 +135126,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -132346,6 +135517,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -132544,6 +135718,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -132638,6 +135815,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132730,6 +135910,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133022,7 +136205,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133054,7 +136237,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133089,7 +136272,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133125,7 +136308,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133215,6 +136398,34 @@ "from" ] }, + "pull_request_reviews_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "require_last_push_approval": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, "required_status_checks": { "type": "object", "properties": { @@ -133263,7 +136474,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133301,7 +136512,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133334,7 +136545,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133380,7 +136591,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133436,7 +136647,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133483,7 +136694,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133517,7 +136728,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -133613,6 +136824,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -133705,6 +136921,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134276,7 +137495,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134297,7 +137516,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -134394,6 +137613,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "Client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -134486,6 +137710,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135055,7 +138282,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135076,7 +138303,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -135168,6 +138395,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The Client ID for the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -135260,6 +138492,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135828,7 +139063,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -135948,6 +139183,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136144,7 +139382,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136265,6 +139503,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136486,7 +139727,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136677,6 +139918,7 @@ "state": { "description": "State of a code scanning alert.", "type": "string", + "nullable": true, "enum": [ "open", "dismissed" @@ -136746,7 +139988,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -136868,6 +140110,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137092,7 +140337,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137346,7 +140591,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137565,7 +140810,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137589,7 +140834,7 @@ ] }, "comment": { - "description": "The [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment) resource.", + "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource.", "type": "object", "properties": { "author_association": { @@ -137741,7 +140986,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -137786,6 +141032,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137823,7 +141072,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137873,7 +141122,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137917,7 +141166,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137928,6 +141177,78 @@ "sender" ] }, + "webhook-dependabot-alert-auto-dismissed": { + "title": "Dependabot alert auto-dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_dismissed" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-auto-reopened": { + "title": "Dependabot alert auto-reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_reopened" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, "webhook-dependabot-alert-created": { "title": "Dependabot alert created event", "type": "object", @@ -137954,7 +141275,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -137990,7 +141311,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138026,7 +141347,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138062,7 +141383,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138098,7 +141419,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138134,7 +141455,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138170,7 +141491,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138192,7 +141513,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -138283,6 +141604,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138496,6 +141820,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138838,7 +142165,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -138933,6 +142260,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139642,6 +142972,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139741,7 +143074,7 @@ "$ref": "#/components/schemas/simple-installation" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } } }, @@ -139776,7 +143109,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -139907,6 +143240,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140122,6 +143458,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -140473,6 +143812,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -140620,6 +143962,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140709,7 +144054,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -140841,6 +144186,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141053,6 +144401,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -141404,6 +144755,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -141550,6 +144904,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141728,6 +145085,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141745,7 +145105,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -141880,6 +145240,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142092,6 +145455,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -142443,6 +145809,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -142590,6 +145959,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142753,7 +146125,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -142844,6 +146216,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143058,6 +146433,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143388,7 +146766,7 @@ ] }, "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#list-deployment-statuses).", + "description": "The [deployment status](https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#list-deployment-statuses).", "type": "object", "properties": { "created_at": { @@ -143479,6 +146857,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143691,6 +147072,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144019,7 +147403,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -144114,6 +147498,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144824,6 +148211,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144910,7 +148300,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145010,7 +148400,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145047,7 +148437,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145086,7 +148476,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145126,7 +148516,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145185,7 +148575,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145223,7 +148613,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145259,7 +148649,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145322,7 +148712,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145361,7 +148751,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145398,7 +148788,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145434,7 +148824,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145470,7 +148860,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145521,7 +148911,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145555,7 +148945,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145594,7 +148984,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145631,7 +149021,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145667,7 +149057,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145687,7 +149077,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145704,7 +149094,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145720,7 +149110,7 @@ "$ref": "#/components/schemas/enterprise-webhooks" }, "forkee": { - "description": "The created [`repository`](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository) resource.", + "description": "The created [`repository`](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#get-a-repository) resource.", "allOf": [ { "title": "Repository", @@ -145814,11 +149204,6 @@ } ] }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -145917,7 +149302,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -146102,6 +149488,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146623,8 +150012,7 @@ } } } - ], - "properties": {} + ] }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -146636,7 +150024,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146656,7 +150044,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146727,7 +150115,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146765,7 +150153,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146803,7 +150191,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146841,7 +150229,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146909,7 +150297,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -146988,7 +150376,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147030,7 +150418,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147153,6 +150541,9 @@ }, "website_url": { "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147208,7 +150599,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "target_type": { "type": "string" @@ -147251,7 +150642,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147272,7 +150663,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -147415,7 +150806,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -147460,6 +150852,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147490,11 +150885,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -147594,6 +150989,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147689,6 +151087,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147903,6 +151304,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148163,6 +151567,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148524,6 +151931,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -148593,7 +152020,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -148639,6 +152067,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148764,6 +152195,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148954,7 +152388,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -149005,7 +152440,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149036,11 +152471,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -149140,6 +152575,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149235,6 +152673,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149449,6 +152890,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149707,6 +153151,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150066,6 +153513,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -150135,7 +153602,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -150181,6 +153649,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150306,6 +153777,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150496,7 +153970,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -150527,6 +154002,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -150547,7 +154025,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -150581,11 +154059,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -150685,6 +154163,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150780,6 +154261,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150994,6 +154478,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151254,6 +154741,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151614,6 +155104,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -151683,7 +155193,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -151729,6 +155240,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151854,6 +155368,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152044,7 +155561,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -152095,7 +155613,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -152137,7 +155655,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -152165,11 +155683,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -152269,6 +155787,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152364,6 +155885,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152578,6 +156102,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152839,6 +156366,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153199,6 +156729,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -153268,7 +156818,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -153314,6 +156865,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153502,7 +157056,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -153533,6 +157088,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -153551,7 +157109,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -153579,7 +157137,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -153678,6 +157236,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153985,6 +157546,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154244,6 +157808,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154603,6 +158170,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -154672,7 +158259,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -154717,6 +158305,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154756,7 +158347,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154784,7 +158375,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -155239,6 +158830,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -155490,6 +159084,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -155835,6 +159432,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -155908,7 +159525,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -155954,6 +159572,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -155969,7 +159590,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156027,7 +159648,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -156127,6 +159748,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156436,6 +160060,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156697,6 +160324,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157057,6 +160687,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -157126,7 +160776,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -157172,6 +160823,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157214,7 +160868,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -157243,7 +160897,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -157343,6 +160997,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157652,6 +161309,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157912,6 +161572,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158272,6 +161935,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -158341,7 +162024,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -158387,6 +162071,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158429,7 +162116,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -158457,7 +162144,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -158584,6 +162271,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -158678,6 +162368,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -158913,6 +162606,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -159166,6 +162862,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -159510,6 +163209,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -159583,7 +163302,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -159628,6 +163348,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -159640,7 +163363,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -159668,7 +163391,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -160121,6 +163844,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -160373,6 +164099,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -160718,6 +164447,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -160791,7 +164540,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -160836,6 +164586,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -160851,7 +164604,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160877,7 +164630,7 @@ "properties": { "old_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "nullable": true, "properties": { @@ -160977,6 +164730,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161071,6 +164827,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161284,6 +165043,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161542,6 +165304,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161901,6 +165666,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -161970,7 +165755,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -162015,6 +165801,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162139,6 +165928,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -162241,7 +166035,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -162426,6 +166221,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162657,7 +166455,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -162756,6 +166554,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162850,6 +166651,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163064,6 +166868,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163325,6 +167132,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163685,6 +167495,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -163754,7 +167584,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -163799,6 +167630,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163838,7 +167672,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163874,7 +167708,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163902,7 +167736,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -164357,6 +168191,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -164610,6 +168447,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -164956,6 +168796,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -165029,7 +168889,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -165075,6 +168936,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -165087,7 +168951,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165112,7 +168976,7 @@ "properties": { "new_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -165211,6 +169075,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165305,6 +169172,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165518,6 +169388,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165776,6 +169649,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166135,6 +170011,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -166204,7 +170100,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -166249,6 +170146,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166373,6 +170273,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -166476,7 +170381,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -166661,6 +170567,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166901,7 +170810,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166942,7 +170851,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166981,7 +170890,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167009,7 +170918,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -167136,6 +171045,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -167230,6 +171142,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -167465,6 +171380,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -167716,6 +171634,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -168060,6 +171981,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -168133,7 +172074,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -168178,6 +172120,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -168190,7 +172135,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168226,7 +172171,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168262,7 +172207,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168297,7 +172242,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168375,7 +172320,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168399,7 +172344,6 @@ "type": "object", "properties": { "permission": { - "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.", "type": "object", "properties": { "to": { @@ -168414,18 +172358,6 @@ "required": [ "to" ] - }, - "role_name": { - "description": "The role assigned to the collaborator.", - "type": "object", - "properties": { - "to": { - "type": "string" - } - }, - "required": [ - "to" - ] } } }, @@ -168445,7 +172377,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168512,7 +172444,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168549,7 +172481,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168676,6 +172608,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168814,6 +172749,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168983,7 +172921,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169018,7 +172956,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169054,7 +172992,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169090,7 +173028,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169168,7 +173106,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169205,7 +173143,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169241,7 +173179,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169276,7 +173214,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169415,6 +173353,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169460,7 +173401,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -169499,7 +173440,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169548,7 +173489,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169739,6 +173680,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169838,6 +173782,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170274,6 +174221,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170423,7 +174373,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -170563,6 +174513,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170661,6 +174614,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170871,6 +174827,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171026,7 +174985,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171041,7 +175000,7 @@ "type": "object", "properties": { "build": { - "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.11/rest/pages/pages#list-github-pages-builds) itself.", + "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.13/rest/pages/pages#list-github-pages-builds) itself.", "type": "object", "properties": { "commit": { @@ -171151,6 +175110,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171196,7 +175158,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171219,11 +175181,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -171250,11 +175215,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -171281,11 +175249,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -171295,8 +175266,7 @@ "action", "personal_access_token_request", "organization", - "sender", - "installation" + "sender" ] }, "webhook-personal-access-token-request-denied": { @@ -171315,8 +175285,11 @@ "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -171434,7 +175407,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "zen": { "description": "Random string of GitHub zen.", @@ -171500,7 +175473,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171536,7 +175509,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171678,6 +175651,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171727,7 +175703,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171782,7 +175758,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -171945,6 +175921,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172099,7 +176078,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172134,7 +176113,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172169,7 +176148,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172203,7 +176182,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172253,7 +176232,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172288,7 +176267,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172323,7 +176302,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172358,7 +176337,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172422,7 +176401,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172456,7 +176435,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172485,7 +176464,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172515,7 +176494,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172545,7 +176524,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172628,7 +176607,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172662,7 +176641,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172710,7 +176689,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172741,7 +176720,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172771,7 +176750,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172792,6 +176771,7 @@ ] }, "changes": { + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes the GraphQL node ID of the changed field.", "oneOf": [ { "type": "object", @@ -172845,7 +176825,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172893,7 +176873,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172927,7 +176907,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172958,7 +176938,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172985,7 +176965,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -173241,6 +177221,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173336,6 +177319,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173460,6 +177446,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173688,7 +177677,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -173890,6 +177880,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174029,7 +178022,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -174173,7 +178166,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -174218,6 +178212,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174481,7 +178478,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -174683,6 +178681,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174822,7 +178823,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -174966,7 +178967,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -175011,6 +179013,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175194,6 +179199,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175305,6 +179313,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175487,6 +179498,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175842,7 +179856,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -175888,6 +179903,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175939,7 +179957,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -176195,6 +180213,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176413,6 +180434,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176641,7 +180665,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -176843,6 +180868,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176982,7 +181010,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -177126,7 +181154,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -177171,6 +181200,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177432,7 +181464,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -177634,6 +181667,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177773,7 +181809,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -177917,7 +181953,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -177962,6 +181999,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178145,6 +182185,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178255,6 +182298,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178437,6 +182483,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178792,7 +182841,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -178838,6 +182888,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178892,7 +182945,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -179148,6 +183201,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179366,6 +183422,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179594,7 +183653,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -179796,6 +183856,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179935,7 +183998,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -180079,7 +184142,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -180124,6 +184188,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180587,6 +184654,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180726,7 +184796,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -180870,7 +184940,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -180915,6 +184986,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181098,6 +185172,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181209,6 +185286,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181391,6 +185471,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181746,7 +185829,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -181792,6 +185876,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181846,7 +185933,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181886,7 +185973,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181926,7 +186013,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181966,7 +186053,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182066,7 +186153,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -182325,6 +186412,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182544,6 +186634,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182772,7 +186865,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -182974,6 +187068,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183113,7 +187210,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -183257,7 +187354,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -183302,6 +187400,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183565,7 +187666,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -183767,6 +187869,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183906,7 +188011,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -184050,7 +188155,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184095,6 +188201,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184279,6 +188388,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184390,6 +188502,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184572,6 +188687,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184927,7 +189045,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184973,6 +189092,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185024,7 +189146,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -185279,6 +189401,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185498,6 +189623,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185726,7 +189854,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -185928,6 +190057,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186067,7 +190199,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -186211,7 +190343,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -186256,6 +190389,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186519,7 +190655,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -186721,6 +190858,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186860,7 +191000,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -187004,7 +191144,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187049,6 +191190,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187233,6 +191377,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187343,6 +191490,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187525,6 +191675,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187880,7 +192033,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187926,6 +192080,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187977,7 +192134,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -188017,7 +192174,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -188056,7 +192213,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -188096,7 +192253,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -188136,7 +192293,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -188159,7 +192316,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -188431,7 +192588,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -188476,6 +192634,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188740,6 +192901,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188959,6 +193123,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189187,7 +193354,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -189389,6 +193557,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189528,7 +193699,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -189672,7 +193843,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -189717,6 +193889,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189964,7 +194139,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -190166,6 +194342,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190305,7 +194484,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -190448,7 +194627,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -190493,6 +194673,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190679,6 +194862,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190856,6 +195042,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191205,7 +195394,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -191251,6 +195441,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191300,7 +195493,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -191551,6 +195744,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191769,6 +195965,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191997,7 +196196,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -192199,6 +196399,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192338,7 +196541,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -192482,7 +196685,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -192527,6 +196731,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192774,7 +196981,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -192976,6 +197184,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193115,7 +197326,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -193259,7 +197470,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193304,6 +197516,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193489,6 +197704,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193665,6 +197883,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194005,7 +198226,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -194051,6 +198273,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194100,7 +198325,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -194354,6 +198579,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194448,6 +198676,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194572,6 +198803,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194800,7 +199034,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -195002,6 +199237,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195141,7 +199379,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -195285,7 +199523,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -195330,6 +199569,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195577,7 +199819,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -195779,6 +200022,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195918,7 +200164,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -196062,7 +200308,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196107,6 +200354,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196293,6 +200543,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196469,6 +200722,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196809,7 +201065,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196852,6 +201109,9 @@ "Mannequin" ] }, + "user_view_type": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -196904,7 +201164,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -197155,6 +201415,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197374,6 +201637,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197602,7 +201868,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -197804,6 +202071,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197943,7 +202213,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -198087,7 +202357,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -198132,6 +202403,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198379,7 +202653,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -198581,6 +202856,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198720,7 +202998,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -198864,7 +203142,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -198909,6 +203188,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199094,6 +203376,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199271,6 +203556,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199620,7 +203908,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199666,6 +203955,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199846,7 +204138,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199892,6 +204185,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199915,7 +204211,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -200182,6 +204478,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200401,6 +204700,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200624,7 +204926,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -200809,6 +205112,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201065,7 +205371,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -201110,6 +205417,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201352,7 +205662,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -201537,6 +205848,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201793,7 +206107,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -201838,6 +206153,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202024,6 +206342,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202201,6 +206522,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202550,7 +206874,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202596,6 +206921,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202650,7 +206978,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -202909,6 +207237,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203003,6 +207334,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203127,6 +207461,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203355,7 +207692,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -203557,6 +207895,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203696,7 +208037,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -203840,7 +208181,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -203885,6 +208227,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204146,7 +208491,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -204348,6 +208694,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204487,7 +208836,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -204631,7 +208980,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -204676,6 +209026,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204859,6 +209212,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204969,6 +209325,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205150,6 +209509,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205514,7 +209876,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -205559,6 +209922,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205694,6 +210060,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205702,7 +210071,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -205958,6 +210327,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206052,6 +210424,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206176,6 +210551,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206404,7 +210782,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -206606,6 +210985,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206745,7 +211127,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -206889,7 +211271,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -206934,6 +211317,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207195,7 +211581,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -207397,6 +211784,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207536,7 +211926,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -207680,7 +212070,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -207725,6 +212116,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207908,6 +212302,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208018,6 +212415,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208199,6 +212599,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208563,7 +212966,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -208608,6 +213012,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208797,7 +213204,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -209059,6 +213466,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209154,6 +213564,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209278,6 +213691,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209506,7 +213922,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -209708,6 +214125,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209847,7 +214267,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -209991,7 +214411,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -210036,6 +214457,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210297,7 +214721,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -210499,6 +214924,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210638,7 +215066,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -210782,7 +215210,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -210827,6 +215256,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211010,6 +215442,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211121,6 +215556,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211302,6 +215740,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211657,7 +216098,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -211703,6 +216145,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211839,6 +216284,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211847,7 +216295,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -212104,6 +216552,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212199,6 +216650,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212323,6 +216777,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212551,7 +217008,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -212753,6 +217211,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212892,7 +217353,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -213036,7 +217497,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -213081,6 +217543,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213342,7 +217807,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -213544,6 +218010,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213683,7 +218152,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -213827,7 +218296,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -213872,6 +218342,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214055,6 +218528,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214166,6 +218642,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214347,6 +218826,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214693,7 +219175,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214739,6 +219222,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214919,7 +219405,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -215172,6 +219658,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215391,6 +219880,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215619,7 +220111,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -215821,6 +220314,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215960,7 +220456,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -216104,7 +220600,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -216149,6 +220646,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216397,7 +220897,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -216599,6 +221100,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216738,7 +221242,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -216882,7 +221386,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -216927,6 +221432,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217113,6 +221621,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217290,6 +221801,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217639,7 +222153,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217685,6 +222200,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217739,7 +222257,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -217988,6 +222506,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218206,6 +222727,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218434,7 +222958,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -218619,6 +223144,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218880,7 +223408,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -218925,6 +223454,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219173,7 +223705,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -219358,6 +223891,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219619,7 +224155,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -219664,6 +224201,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219849,6 +224389,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220026,6 +224569,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220375,7 +224921,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220421,6 +224968,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220472,7 +225022,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -220481,7 +225031,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -220753,7 +225303,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220799,6 +225350,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221091,6 +225645,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221308,6 +225865,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221536,7 +226096,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -221721,6 +226282,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221982,7 +226546,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222027,6 +226592,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222273,7 +226841,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -222458,6 +227027,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222719,7 +227291,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222764,6 +227337,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222949,6 +227525,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223125,6 +227704,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223465,7 +228047,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -223510,6 +228093,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223561,7 +228147,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -223570,7 +228156,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -223841,7 +228427,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -223886,6 +228473,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224191,6 +228781,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224410,6 +229003,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224638,7 +229234,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -224840,6 +229437,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224979,7 +229579,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -225123,7 +229723,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -225168,6 +229769,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225429,7 +230033,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -225631,6 +230236,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225770,7 +230378,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -225914,7 +230522,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -225959,6 +230568,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226142,6 +230754,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226253,6 +230868,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226435,6 +231053,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226790,7 +231411,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226836,6 +231458,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226887,7 +231512,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -227148,6 +231773,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227367,6 +231995,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227596,7 +232227,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -227798,6 +232430,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227937,7 +232572,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -228081,7 +232716,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -228126,6 +232762,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228389,7 +233028,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -228591,6 +233231,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228730,7 +233373,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -228874,7 +233517,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -228919,6 +233563,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229103,6 +233750,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229214,6 +233864,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229396,6 +234049,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229751,7 +234407,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -229797,6 +234454,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229848,7 +234508,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -230106,6 +234766,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230325,6 +234988,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230553,7 +235219,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -230755,6 +235422,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230894,7 +235564,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -231038,7 +235708,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -231083,6 +235754,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231346,7 +236020,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -231548,6 +236223,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231687,7 +236365,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -231831,7 +236509,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -231876,6 +236555,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232059,6 +236741,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232170,6 +236855,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232352,6 +237040,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232707,7 +237398,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -232753,6 +237445,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232804,7 +237499,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233059,6 +237754,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233276,6 +237974,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233504,7 +238205,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -233706,6 +238408,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233845,7 +238550,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -233989,7 +238694,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -234034,6 +238740,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234296,7 +239005,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -234498,6 +239208,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234637,7 +239350,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -234781,7 +239494,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -234826,6 +239540,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235009,6 +239726,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235119,6 +239839,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235300,6 +240023,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235646,7 +240372,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -235691,6 +240418,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235742,7 +240472,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235769,7 +240499,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.11/rest/commits) to fetch additional commits.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.13/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -236150,6 +240880,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -236253,7 +240988,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -236438,6 +241174,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236657,7 +241396,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236775,6 +241514,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236861,6 +241603,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237320,6 +242065,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -237439,7 +242187,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -237546,6 +242294,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237631,6 +242382,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237814,6 +242568,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237954,7 +242711,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -237989,7 +242746,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238025,7 +242782,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238102,7 +242859,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238133,7 +242890,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -238412,6 +243169,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -238539,7 +243299,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238574,7 +243334,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238609,7 +243369,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238644,7 +243404,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238675,7 +243435,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238704,7 +243464,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238734,7 +243494,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238766,7 +243526,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238798,7 +243558,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238837,7 +243597,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238924,7 +243684,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238957,7 +243717,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238989,7 +243749,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239048,7 +243808,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239084,7 +243844,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239119,7 +243879,7 @@ "$ref": "#/components/schemas/repository-ruleset" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239303,7 +244063,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239440,7 +244200,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -239485,6 +244246,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239517,7 +244281,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239550,7 +244314,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239585,7 +244349,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239734,6 +244498,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -239791,7 +244558,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -239827,7 +244594,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240027,7 +244794,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240063,7 +244830,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240098,7 +244865,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240147,7 +244914,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240182,7 +244949,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240191,14 +244958,14 @@ "repository" ] }, - "webhook-secret-scanning-alert-revoked": { - "title": "secret_scanning_alert revoked event", + "webhook-secret-scanning-alert-validated": { + "title": "secret_scanning_alert validated event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "revoked" + "validated" ] }, "alert": { @@ -240217,7 +244984,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240252,7 +245019,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240286,7 +245053,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240336,6 +245103,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -240472,7 +245242,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240510,7 +245280,7 @@ "$ref": "#/components/schemas/full-repository" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -240541,7 +245311,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -240576,7 +245346,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -240628,7 +245398,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -240667,7 +245437,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -240708,7 +245478,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -240747,7 +245517,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -240783,7 +245553,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -240821,7 +245591,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -241325,7 +246095,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sha": { "description": "The Commit SHA.", @@ -241383,7 +246153,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -241506,6 +246276,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -241604,7 +246379,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -241789,6 +246565,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242003,7 +246782,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -242126,6 +246905,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -242224,7 +247008,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -242409,6 +247194,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242623,7 +247411,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -242747,6 +247535,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -242845,7 +247638,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -243030,6 +247824,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243244,7 +248041,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -243454,6 +248251,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -243552,7 +248354,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -243737,6 +248540,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243951,7 +248757,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -244076,6 +248882,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -244174,7 +248985,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -244359,6 +249171,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -244573,7 +249388,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -244608,7 +249423,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -244640,7 +249455,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -244673,7 +249488,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -244707,7 +249522,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "type": "string" @@ -244744,7 +249559,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -244790,7 +249605,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.11/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.13/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -245075,7 +249890,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -245118,7 +249933,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.11/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.13/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -245438,7 +250253,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -245646,7 +250461,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -245855,7 +250670,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -245988,6 +250803,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -246020,7 +250838,8 @@ "skipped", "stale", "success", - "timed_out" + "timed_out", + "startup_failure" ] }, "created_at": { @@ -246388,6 +251207,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -246866,6 +251688,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -247029,6 +251854,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -247086,7 +251914,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -248312,7 +253140,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -248406,6 +253234,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -248760,6 +253591,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -249237,6 +254071,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -249448,6 +254285,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -249919,7 +254759,7 @@ "allow_downstream_configuration": true } }, - "authorization-items": { + "classic-personal-access-tokens": { "value": [ { "id": 2, @@ -250049,12 +254889,28 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", "name": "Uncontrolled Resource Consumption" } ], + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], "credits": [ { "user": { @@ -250130,6 +254986,16 @@ "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", "score": 7.6 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, "cwes": [ { "cwe_id": "CWE-400", @@ -250167,6 +255033,7 @@ "value": { "id": 1, "slug": "octoapp", + "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", @@ -250274,7 +255141,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, @@ -250287,7 +255155,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": null } ] }, @@ -250305,6 +255174,7 @@ "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -250777,6 +255647,42 @@ } } }, + "authorization-items": { + "value": [ + { + "id": 2, + "url": "https://enterprise.octocat.com/api/v3/authorizations/2", + "app": { + "name": "My personal access token", + "url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens", + "client_id": "00000000000000000000" + }, + "token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a", + "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45", + "token_last_eight": "Ae178B4a", + "note": "My personal access token", + "note_url": null, + "created_at": "2019-04-24T21:49:02Z", + "updated_at": "2019-04-24T21:49:02Z", + "scopes": [ + "admin:business", + "admin:gpg_key", + "admin:org", + "admin:org_hook", + "admin:pre_receive_hook", + "admin:public_key", + "admin:repo_hook", + "delete_repo", + "gist", + "notifications", + "repo", + "user", + "write:discussion" + ], + "fingerprint": null + } + ] + }, "authorization-response-if-returning-an-existing-token-2": { "value": { "id": 1, @@ -253676,6 +258582,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -253876,6 +258792,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -254120,7 +259046,31 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active" }, { "number": 1, @@ -254205,7 +259155,12 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" } ] }, @@ -254213,6 +259168,8 @@ "value": { "total_advanced_security_committers": 2, "total_count": 2, + "maximum_advanced_security_committers": 4, + "purchased_advanced_security_committers": 4, "repositories": [ { "name": "octocat-org/Hello-World", @@ -254220,11 +259177,13 @@ "advanced_security_committers_breakdown": [ { "user_login": "octocat", - "last_pushed_date": "2021-11-03" + "last_pushed_date": "2021-11-03", + "last_pushed_email": "octocat@github.com" }, { "user_login": "octokitten", - "last_pushed_date": "2021-10-25" + "last_pushed_date": "2021-10-25", + "last_pushed_email": "octokitten@github.com" } ] }, @@ -254234,7 +259193,8 @@ "advanced_security_committers_breakdown": [ { "user_login": "octokitten", - "last_pushed_date": "2021-10-26" + "last_pushed_date": "2021-10-26", + "last_pushed_email": "octokitten@github.com" } ] } @@ -254421,7 +259381,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -254429,7 +259390,6 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", @@ -255317,6 +260277,191 @@ "featured": true } }, + "ghes-get-ssh": { + "value": [ + { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ==", + "fingeprint": "bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45" + }, + { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw==", + "fingeprint": "e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4" + } + ] + }, + "ghes-set-ssh": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "SSH key added successfully", + "modified": true + } + ] + }, + "ghes-delete-ssh": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "SSH key removed successfully" + } + ] + }, + "ghes-checks-system-requirements": { + "value": { + "status": "OK", + "nodes": [ + { + "hostname": "ghe-local-app", + "status": "OK", + "roles_status": [ + { + "status": "OK", + "role": "ConsulServer" + }, + { + "status": "OK", + "role": "JobServer" + }, + { + "status": "OK", + "role": "WebServer" + } + ] + }, + { + "hostname": "ghe-local-app2", + "status": "OK", + "roles_status": [ + { + "status": "OK", + "role": "ConsulServer" + }, + { + "status": "OK", + "role": "GitServer" + } + ] + } + ] + } + }, + "ghes-cluster-status": { + "value": { + "status": "OK", + "nodes": [ + { + "hostname": "ghe-local-app", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "es", + "details": "Elasticsearch cluster is in sync (0 shards initializing, 0 shards unassigned)" + }, + { + "status": "OK", + "name": "git-replication", + "details": "Git replication is in sync" + }, + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + }, + { + "status": "OK", + "name": "memcache", + "details": "" + }, + { + "status": "OK", + "name": "metrics", + "details": "" + }, + { + "status": "OK", + "name": "mysql-replication", + "details": "Replication is running" + }, + { + "status": "OK", + "name": "mysql-failover", + "details": "" + }, + { + "status": "OK", + "name": "pages", + "details": "Pages replication is in sync" + }, + { + "status": "OK", + "name": "redis", + "details": "Redis is OK" + }, + { + "status": "OK", + "name": "storage", + "details": "Storage replication is in sync" + } + ] + }, + { + "hostname": "ghe-local-app2", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + } + ] + } + ] + } + }, + "ghes-license-info": { + "value": [ + { + "advancedSecurityEnabled": true, + "advancedSecuritySeats": 0, + "clusterSupport": false, + "company": "GitHub", + "croquetSupport": true, + "customTerms": true, + "evaluation": false, + "expireAt": "2025-01-02T07:59:59Z", + "insightsEnabled": true, + "insightsExpireAt": "2025-01-02T07:59:59.999Z", + "learningLabEvaluationExpires": "2023-01-02T07:59:59Z", + "learningLabSeats": 100, + "perpetual": false, + "referenceNumber": "32a145", + "seats": 0, + "sshAllowed": true, + "supportKey\"": "", + "unlimitedSeating": true + } + ] + }, + "ghes-license-check": { + "value": [ + { + "status": "valid" + } + ] + }, "ghes-config-nodes": { "value": { "topology": "Cluster", @@ -255343,6 +260488,143 @@ ] } }, + "ghes-get-settings": { + "value": { + "private_mode": false, + "public_pages": false, + "subdomain_isolation": true, + "signup_enabled": false, + "github_hostname": "ghe.local", + "identicons_host": "dotcom", + "http_proxy": null, + "auth_mode": "default", + "expire_sessions": false, + "admin_password": null, + "configuration_id": 1401777404, + "configuration_run_count": 4, + "avatar": { + "enabled": false, + "uri": "" + }, + "customer": { + "name": "GitHub", + "email": "stannis@themannis.biz", + "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9", + "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", + "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n" + }, + "license": { + "seats": 0, + "evaluation": false, + "perpetual": false, + "unlimited_seating": true, + "support_key": "ssh-rsa AAAAB3N....", + "ssh_allowed": true, + "cluster_support": false, + "expire_at": "2016-04-27T00:00:00-07:00" + }, + "github_ssl": { + "enabled": false, + "cert": null, + "key": null + }, + "ldap": { + "host": null, + "port": 0, + "base": [], + "uid": null, + "bind_dn": null, + "password": null, + "method": "Plain", + "search_strategy": "detect", + "user_groups": [], + "admin_group": null, + "virtual_attribute_enabled": false, + "recursive_group_search": false, + "posix_support": true, + "user_sync_emails": false, + "user_sync_keys": false, + "user_sync_interval": 4, + "team_sync_interval": 4, + "sync_enabled": false, + "reconciliation": { + "user": null, + "org": null + }, + "profile": { + "uid": "uid", + "name": null, + "mail": null, + "key": null + } + }, + "cas": { + "url": null + }, + "saml": { + "sso_url": null, + "certificate": null, + "certificate_path": null, + "issuer": null, + "idp_initiated_sso": false, + "disable_admin_demote": false + }, + "github_oauth": { + "client_id": "12313412", + "client_secret": "kj123131132", + "organization_name": "Homestar Runners", + "organization_team": "homestarrunners/characters" + }, + "smtp": { + "enabled": true, + "address": "smtp.example.com", + "authentication": "plain", + "port": "1234", + "domain": "blah", + "username": "foo", + "user_name": "mr_foo", + "enable_starttls_auto": true, + "password": "bar", + "discard-to-noreply-address": true, + "support_address": "enterprise@github.com", + "support_address_type": "email", + "noreply_address": "noreply@github.com" + }, + "ntp": { + "primary_server": "0.pool.ntp.org", + "secondary_server": "1.pool.ntp.org" + }, + "timezone": null, + "snmp": { + "enabled": false, + "community": "" + }, + "syslog": { + "enabled": false, + "server": null, + "protocol_name": "udp" + }, + "assets": null, + "pages": { + "enabled": true + }, + "collectd": { + "enabled": false, + "server": null, + "port": 0, + "encryption": null, + "username": null, + "password": null + }, + "mapping": { + "enabled": true, + "tileserver": null, + "basemap": "company.map-qsz2zrvs", + "token": null + }, + "load_balancer": null + } + }, "ghes-get-maintenance": { "value": [ { @@ -255462,9 +260744,6 @@ "packages": [ "192.0.2.1" ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -255479,7 +260758,7 @@ "*.example.com" ] }, - "installed_version": "3.11.0" + "installed_version": "3.13.0" } }, "public-repo-events-items": { @@ -256883,6 +262162,7 @@ "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, + "client_id": "Iv1.ab1112223334445c", "target_id": 1, "target_type": "Organization", "permissions": { @@ -257749,6 +263029,8 @@ } }, "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -257790,6 +263072,8 @@ } }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -257901,6 +263185,97 @@ "updated_at": "2014-03-04T18:58:10Z" } }, + "custom-properties": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "custom-property": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "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" + } + ] + } + }, "full-repository": { "value": { "id": 1296269, @@ -258527,6 +263902,81 @@ "updated_at": "2023-09-23T16:29:47Z" } }, + "rule-suite-items": { + "value": [ + { + "id": 21, + "actor_id": 12, + "actor_name": "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, + "actor_name": "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, + "actor_name": "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" + } + ] + } + }, "team-items": { "value": [ { @@ -259437,6 +264887,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -259682,6 +265138,7 @@ "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, + "allow_forking": true, "subscribers_count": 42, "network_count": 0, "license": { @@ -261108,9 +266565,7 @@ "comment_count": 77, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", @@ -261728,9 +267183,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "comment_count": 0 }, @@ -264055,9 +269508,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -264483,9 +269934,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -264561,9 +270010,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -264911,9 +270358,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -264965,16 +270410,13 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } }, "file-commit": { "value": { - "content": null, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -265004,9 +270446,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -265083,6 +270523,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -265216,6 +270666,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -265327,6 +270787,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -265426,6 +270896,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -265585,10 +271065,7 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { "SPDXID": "SPDXRef-Package", @@ -265596,8 +271073,20 @@ "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, - "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseConcluded": "NOASSERTION", + "licenseDeclared": "NOASSERTION" + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -265998,6 +271487,14 @@ "name": "main" } }, + "deployment-branch-policy-single-tag": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "v1", + "type": "tag" + } + }, "deployment-protection-rules": { "value": [ { @@ -266295,9 +271792,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } @@ -266332,9 +271827,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -266393,9 +271886,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -267778,19 +273269,21 @@ ] }, "deploy-key-items": { - "value": [ - { - "id": 1, - "key": "ssh-rsa AAA...", - "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", - "title": "octocat@octomac", - "verified": true, - "created_at": "2014-12-10T15:53:42Z", - "read_only": true, - "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" - } - ] + "value": { + "enabled": [ + { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z" + } + ] + } }, "deploy-key": { "value": { @@ -267959,6 +273452,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -268046,10 +273541,16 @@ }, "page-deployment": { "value": { - "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251", + "id": "4fd754f7e594640989b406850d0bc8f06a121251", + "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", "page_url": "developer.github.com" } }, + "pages-deployment-status": { + "value": { + "status": "succeed" + } + }, "repository-pre-receive-hook-items": { "value": [ { @@ -268114,6 +273615,40 @@ } ] }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "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", @@ -270754,7 +276289,31 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "inactive" }, { "number": 1, @@ -270772,7 +276331,12 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" } ] }, @@ -270787,7 +276351,8 @@ "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed": false + "push_protection_bypassed": false, + "validity": "unknown" } }, "secret-scanning-alert-resolved": { @@ -270824,7 +276389,8 @@ "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed": false, - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "unknown" } }, "secret-scanning-location-list": { @@ -270896,7 +276462,7 @@ { "type": "pull_request_title", "details": { - "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, { @@ -271574,7 +277140,7 @@ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "id": "927fa2c08dcb4a7fae9e", + "id": "24b28bbb-5fc4-4686-a153-a020debb1155", "displayName": "Engineering", "members": [ { @@ -271592,7 +277158,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } ], @@ -271624,7 +277190,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } }, @@ -276172,9 +281738,6 @@ "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, "secret_type": "mailchimp_api_key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" }, @@ -276318,7 +281881,7 @@ "parameters": { "per-page": { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -276327,7 +281890,7 @@ }, "page": { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -276422,7 +281985,7 @@ }, "pagination-before": { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -276431,7 +281994,7 @@ }, "pagination-after": { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "required": false, "schema": { @@ -276598,7 +282161,7 @@ }, "audit-log-enterprise-phrase": { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", "in": "query", "required": false, "schema": { @@ -276621,7 +282184,7 @@ }, "audit-log-after": { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", "required": false, "schema": { @@ -276630,7 +282193,7 @@ }, "audit-log-before": { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -276764,7 +282327,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", + "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.13/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -276793,6 +282356,15 @@ "default": "created" } }, + "secret-scanning-alert-validity": { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, "enterprise-security-product": { "name": "security_product", "in": "path", @@ -276802,6 +282374,7 @@ "type": "string", "enum": [ "advanced_security", + "advanced_security_user_namespace", "dependabot_alerts", "secret_scanning", "secret_scanning_push_protection" @@ -276836,7 +282409,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "labels": { @@ -276848,6 +282422,15 @@ "type": "string" } }, + "license-apply": { + "name": "apply", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, "uuid": { "name": "uuid", "description": "The UUID which identifies a node.", @@ -276916,7 +282499,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -276961,7 +282544,7 @@ }, "variables-per-page": { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -276979,7 +282562,7 @@ }, "audit-log-phrase": { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", "in": "query", "required": false, "schema": { @@ -277004,6 +282587,24 @@ "type": "integer" } }, + "members-per-page": { + "name": "per_page", + "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + "members-page": { + "name": "page", + "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, "migration-id": { "name": "migration_id", "description": "The unique identifier of the migration.", @@ -277024,7 +282625,7 @@ }, "package-visibility": { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { @@ -277147,9 +282748,93 @@ "type": "integer" } }, + "custom-property-name": { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "ruleset-targets": { + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "branch,tag,push" + } + }, + "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 + }, + "repository-name-in-query": { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + "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-server@3.13/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.13/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-server@3.11/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.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/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.", "in": "query", "required": false, "schema": { @@ -277158,7 +282843,7 @@ }, "secret-scanning-pagination-after-org-repo": { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/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.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/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.", "in": "query", "required": false, "schema": { @@ -277357,7 +283042,7 @@ }, "event": { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.11/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.13/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "query", "required": false, "schema": { @@ -277391,7 +283076,7 @@ }, "created": { "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "query", "required": false, "schema": { @@ -277471,7 +283156,7 @@ }, "branch": { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.11/graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.13/graphql).", "in": "path", "required": true, "schema": { @@ -277681,6 +283366,22 @@ "type": "integer" } }, + "pages-deployment-id": { + "name": "pages_deployment_id", + "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + }, "pull-number": { "name": "pull_number", "description": "The number that identifies the pull request.", @@ -277854,6 +283555,15 @@ "default": "created" } }, + "account-id": { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "since-user": { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.", @@ -278112,16 +283822,6 @@ } } }, - "code_scanning_forbidden_read": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, "forbidden_gist": { "description": "Forbidden Gist", "content": { @@ -278201,6 +283901,16 @@ } } }, + "code_scanning_forbidden_read": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "code_scanning_forbidden_write": { "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { diff --git a/cache/ghes-3.10.json b/cache/ghes-3.14.json similarity index 92% rename from cache/ghes-3.10.json rename to cache/ghes-3.14.json index d4cbc9900..0e65284b5 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.14.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.6.0", + "version": "17.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": { @@ -14,7 +14,7 @@ "url": "https://github.com/octokit/openapi" }, "x-github-plan": "ghes", - "x-github-release": 3.1 + "x-github-release": 3.14 }, "tags": [ { @@ -148,6 +148,14 @@ { "name": "enterprise-admin", "description": "Enterprise Administration" + }, + { + "name": "oauth-authorizations", + "description": "OAuth Authorizations API" + }, + { + "name": "security-advisories", + "description": "Manage security advisories." } ], "servers": [ @@ -167,7 +175,7 @@ ], "externalDocs": { "description": "GitHub Enterprise Developer Docs", - "url": "https://docs.github.com/enterprise-server@3.10/rest/" + "url": "https://docs.github.com/enterprise-server@3.14/rest/" }, "paths": { "/": { @@ -203,7 +211,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/meta/meta#github-api-root" + "url": "https://docs.github.com/enterprise-server@3.14/rest/meta/meta#github-api-root" }, "x-octokit": {} } @@ -218,7 +226,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/global-webhooks#list-global-webhooks" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#list-global-webhooks" }, "parameters": [ { @@ -270,7 +278,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/global-webhooks#create-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#create-a-global-webhook" }, "responses": { "201": { @@ -314,7 +322,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers) header." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers) header." }, "insecure_ssl": { "type": "string", @@ -327,7 +335,7 @@ }, "events": { "type": "array", - "description": "The [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "description": "The [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } @@ -381,7 +389,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/global-webhooks#get-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#get-a-global-webhook" }, "parameters": [ { @@ -422,7 +430,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/global-webhooks#update-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#update-a-global-webhook" }, "parameters": [ { @@ -467,7 +475,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers) header." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers) header." }, "insecure_ssl": { "type": "string", @@ -480,7 +488,7 @@ }, "events": { "type": "array", - "description": "The [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "description": "The [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } @@ -524,7 +532,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/global-webhooks#delete-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#delete-a-global-webhook" }, "parameters": [ { @@ -548,14 +556,14 @@ "/admin/hooks/{hook_id}/pings": { "post": { "summary": "Ping a global webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the webhook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) to be sent to the webhook.", "operationId": "enterprise-admin/ping-global-webhook", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/global-webhooks#ping-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#ping-a-global-webhook" }, "parameters": [ { @@ -586,7 +594,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#list-public-keys" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#list-public-keys" }, "parameters": [ { @@ -666,7 +674,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#delete-a-public-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-a-public-key" }, "parameters": [ { @@ -690,14 +698,14 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team" }, "parameters": [ { @@ -766,7 +774,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team" }, "parameters": [ { @@ -816,7 +824,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user" }, "parameters": [ { @@ -885,7 +893,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user" }, "parameters": [ { @@ -935,7 +943,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/orgs#create-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/orgs#create-an-organization" }, "responses": { "201": { @@ -1010,7 +1018,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/orgs#update-an-organization-name" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/orgs#update-an-organization-name" }, "parameters": [ { @@ -1090,7 +1098,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments" }, "parameters": [ { @@ -1154,7 +1162,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment" }, "responses": { "201": { @@ -1224,7 +1232,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment" }, "parameters": [ { @@ -1265,7 +1273,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment" }, "parameters": [ { @@ -1380,7 +1388,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment" }, "parameters": [ { @@ -1457,7 +1465,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download" }, "parameters": [ { @@ -1546,7 +1554,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment" }, "parameters": [ { @@ -1589,7 +1597,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks" }, "parameters": [ { @@ -1654,7 +1662,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook" }, "responses": { "201": { @@ -1754,7 +1762,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook" }, "parameters": [ { @@ -1795,7 +1803,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook" }, "parameters": [ { @@ -1887,7 +1895,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook" }, "parameters": [ { @@ -1918,7 +1926,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#list-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#list-personal-access-tokens" }, "parameters": [ { @@ -1941,7 +1949,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/authorization-items" + "$ref": "#/components/examples/classic-personal-access-tokens" } } } @@ -1972,7 +1980,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#delete-a-personal-access-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-a-personal-access-token" }, "parameters": [ { @@ -1996,14 +2004,14 @@ "/admin/users": { "post": { "summary": "Create a user", - "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", + "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", "operationId": "enterprise-admin/create-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#create-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#create-a-user" }, "responses": { "201": { @@ -2035,7 +2043,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" }, "suspended": { "type": "boolean", @@ -2077,7 +2085,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#update-the-username-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#update-the-username-for-a-user" }, "parameters": [ { @@ -2148,14 +2156,14 @@ }, "delete": { "summary": "Delete a user", - "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", + "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", "operationId": "enterprise-admin/delete-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#delete-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-a-user" }, "parameters": [ { @@ -2186,7 +2194,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#create-an-impersonation-oauth-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#create-an-impersonation-oauth-token" }, "parameters": [ { @@ -2234,7 +2242,7 @@ "properties": { "scopes": { "type": "array", - "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "items": { "type": "string" } @@ -2273,7 +2281,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#delete-an-impersonation-oauth-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-an-impersonation-oauth-token" }, "parameters": [ { @@ -2294,17 +2302,293 @@ "x-octokit": {} } }, + "/advisories": { + "get": { + "summary": "List global security advisories", + "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.14/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/list-global-advisories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/security-advisories/global-advisories#list-global-security-advisories" + }, + "parameters": [ + { + "name": "ghsa_id", + "in": "query", + "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", + "schema": { + "type": "string", + "enum": [ + "reviewed", + "malware", + "unreviewed" + ], + "default": "reviewed" + } + }, + { + "name": "cve_id", + "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "If specified, only advisories for these ecosystems will be returned.", + "schema": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + } + }, + { + "name": "severity", + "in": "query", + "description": "If specified, only advisories with these severities will be returned.", + "schema": { + "type": "string", + "enum": [ + "unknown", + "low", + "medium", + "high", + "critical" + ] + } + }, + { + "name": "cwes", + "in": "query", + "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 1000, + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "published", + "in": "query", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published", + "epss_percentage", + "epss_percentile" + ], + "default": "published" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/global-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "429": { + "description": "Too many requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + }, + "x-octokit": {} + } + }, + "/advisories/{ghsa_id}": { + "get": { + "summary": "Get a global security advisory", + "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/get-global-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/security-advisories/global-advisories#get-a-global-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/global-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + }, + "x-octokit": {} + } + }, "/app": { "get": { "summary": "Get the authenticated app", - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-the-authenticated-app" }, "parameters": [], "responses": { @@ -2336,14 +2620,14 @@ "/app-manifests/{code}/conversions": { "post": { "summary": "Create a GitHub App from a manifest", - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "tags": [ "apps" ], "operationId": "apps/create-from-manifest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-a-github-app-from-a-manifest" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#create-a-github-app-from-a-manifest" }, "parameters": [ { @@ -2419,14 +2703,14 @@ "/app/hook/config": { "get": { "summary": "Get a webhook configuration for an app", - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" }, "responses": { "200": { @@ -2455,14 +2739,14 @@ }, "patch": { "summary": "Update a webhook configuration for an app", - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/update-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" }, "requestBody": { "required": true, @@ -2527,14 +2811,14 @@ "/app/hook/deliveries": { "get": { "summary": "List deliveries for an app webhook", - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/webhooks#list-deliveries-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/webhooks#list-deliveries-for-an-app-webhook" }, "parameters": [ { @@ -2542,14 +2826,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -2590,14 +2866,14 @@ "/app/hook/deliveries/{delivery_id}": { "get": { "summary": "Get a delivery for an app webhook", - "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -2639,14 +2915,14 @@ "/app/hook/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an app webhook", - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -2683,7 +2959,7 @@ "operationId": "apps/list-installation-requests-for-authenticated-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#list-installation-requests-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#list-installation-requests-for-the-authenticated-app" }, "parameters": [ { @@ -3503,14 +3779,14 @@ "/app/installations/{installation_id}": { "get": { "summary": "Get an installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -3547,14 +3823,14 @@ }, "delete": { "summary": "Delete an installation for the authenticated app", - "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/delete-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#delete-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#delete-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -3581,14 +3857,14 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. \n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/create-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#create-an-installation-access-token-for-an-app" }, "parameters": [ { @@ -3682,14 +3958,14 @@ "/app/installations/{installation_id}/suspended": { "put": { "summary": "Suspend an app installation", - "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/suspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#suspend-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation" }, "parameters": [ { @@ -3714,14 +3990,14 @@ }, "delete": { "summary": "Unsuspend an app installation", - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/unsuspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#unsuspend-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#unsuspend-an-app-installation" }, "parameters": [ { @@ -3748,14 +4024,14 @@ "/applications/grants": { "get": { "summary": "List your grants", - "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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/list-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-grants" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-grants" }, "parameters": [ { @@ -3826,14 +4102,14 @@ "/applications/grants/{grant_id}": { "get": { "summary": "Get a single grant", - "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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-grant", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant" }, "parameters": [ { @@ -3879,14 +4155,14 @@ }, "delete": { "summary": "Delete a grant", - "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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/delete-grant", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#delete-a-grant" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#delete-a-grant" }, "parameters": [ { @@ -3922,14 +4198,14 @@ "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", - "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/oauth-applications#delete-an-app-authorization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/oauth-applications#delete-an-app-authorization" }, "parameters": [ { @@ -3982,14 +4258,14 @@ "/applications/{client_id}/token": { "post": { "summary": "Check a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/check-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/oauth-applications#check-a-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/oauth-applications#check-a-token" }, "parameters": [ { @@ -4055,14 +4331,14 @@ }, "patch": { "summary": "Reset a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/reset-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/oauth-applications#reset-a-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/oauth-applications#reset-a-token" }, "parameters": [ { @@ -4125,14 +4401,14 @@ }, "delete": { "summary": "Delete an app token", - "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.", + "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], "operationId": "apps/delete-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/oauth-applications#delete-an-app-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/oauth-applications#delete-an-app-token" }, "parameters": [ { @@ -4185,14 +4461,14 @@ "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", - "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/scope-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-a-scoped-access-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#create-a-scoped-access-token" }, "parameters": [ { @@ -4304,14 +4580,14 @@ "/apps/{app_slug}": { "get": { "summary": "Get an app", - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", + "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "tags": [ "apps" ], "operationId": "apps/get-by-slug", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app" }, "parameters": [ { @@ -4353,14 +4629,14 @@ "/authorizations": { "get": { "summary": "List your authorizations", - "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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/list-authorizations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations" }, "parameters": [ { @@ -4429,14 +4705,14 @@ }, "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. 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.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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.14/rest/authentication/authenticating-to-the-rest-api#using-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.14/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.14/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.14/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" ], "operationId": "oauth-authorizations/create-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization" }, "parameters": [], "requestBody": { @@ -4555,14 +4831,14 @@ "/authorizations/clients/{client_id}": { "put": { "summary": "Get-or-create an authorization for a specific app", - "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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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\n**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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-or-create-authorization-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app" }, "parameters": [ { @@ -4652,7 +4928,7 @@ } }, "201": { - "description": "**Deprecation Notice:** GitHub 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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/).", "content": { "application/json": { "schema": { @@ -4702,14 +4978,14 @@ "/authorizations/clients/{client_id}/{fingerprint}": { "put": { "summary": "Get-or-create an authorization for a specific app and fingerprint", - "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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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).\"", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" }, "parameters": [ { @@ -4844,14 +5120,14 @@ "/authorizations/{authorization_id}": { "get": { "summary": "Get a single 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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization" }, "parameters": [ { @@ -4897,14 +5173,14 @@ }, "patch": { "summary": "Update an existing 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\nIf 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\nYou can only send one of these scope keys at a time.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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\nIf 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/update-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization" }, "parameters": [ { @@ -5009,14 +5285,14 @@ }, "delete": { "summary": "Delete an 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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/delete-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization" }, "parameters": [ { @@ -5059,7 +5335,7 @@ "operationId": "codes-of-conduct/get-all-codes-of-conduct", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" + "url": "https://docs.github.com/enterprise-server@3.14/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" }, "parameters": [], "responses": { @@ -5104,7 +5380,7 @@ "operationId": "codes-of-conduct/get-conduct-code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" + "url": "https://docs.github.com/enterprise-server@3.14/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" }, "parameters": [ { @@ -5158,7 +5434,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/emojis/emojis#get-emojis" + "url": "https://docs.github.com/enterprise-server@3.14/rest/emojis/emojis#get-emojis" }, "parameters": [], "responses": { @@ -5203,7 +5479,7 @@ "operationId": "enterprise-admin/get-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/announcement#get-the-global-announcement-banner" }, "responses": { "200": { @@ -5239,7 +5515,7 @@ "operationId": "enterprise-admin/set-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/announcement#set-the-global-announcement-banner" }, "requestBody": { "required": true, @@ -5293,7 +5569,7 @@ "operationId": "enterprise-admin/remove-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" }, "responses": { "204": { @@ -5319,7 +5595,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/license#get-license-information" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/license#get-license-information" }, "responses": { "200": { @@ -5357,7 +5633,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-all-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-all-statistics" }, "responses": { "200": { @@ -5395,7 +5671,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-comment-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-comment-statistics" }, "responses": { "200": { @@ -5438,7 +5714,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-gist-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-gist-statistics" }, "responses": { "200": { @@ -5479,7 +5755,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-hooks-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-hooks-statistics" }, "responses": { "200": { @@ -5521,7 +5797,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-issue-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-issue-statistics" }, "responses": { "200": { @@ -5563,7 +5839,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-milestone-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-milestone-statistics" }, "responses": { "200": { @@ -5605,7 +5881,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-organization-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-organization-statistics" }, "responses": { "200": { @@ -5648,7 +5924,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-pages-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-pages-statistics" }, "responses": { "200": { @@ -5688,7 +5964,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-pull-request-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-pull-request-statistics" }, "responses": { "200": { @@ -5730,7 +6006,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-repository-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-repository-statistics" }, "responses": { "200": { @@ -5775,7 +6051,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-security-products-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-security-products-statistics" }, "responses": { "200": { @@ -5813,7 +6089,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/admin-stats#get-users-statistics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-users-statistics" }, "responses": { "200": { @@ -5855,7 +6131,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" }, "parameters": [ { @@ -5903,7 +6179,7 @@ "operationId": "actions/get-actions-cache-usage-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise" }, "parameters": [ { @@ -5949,7 +6225,7 @@ "operationId": "actions/set-actions-cache-usage-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise" }, "parameters": [ { @@ -5995,7 +6271,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -6036,7 +6312,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -6096,7 +6372,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6158,7 +6434,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6222,7 +6498,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6254,7 +6530,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6288,7 +6564,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -6329,7 +6605,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -6368,14 +6644,14 @@ "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -6409,14 +6685,14 @@ }, "put": { "summary": "Set default workflow permissions for an enterprise", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -6462,7 +6738,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" }, "parameters": [ { @@ -6527,7 +6803,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6648,7 +6924,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6692,7 +6968,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6788,7 +7064,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" }, "parameters": [ { @@ -6822,7 +7098,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -6887,7 +7163,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -6954,7 +7230,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -6989,7 +7265,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -7026,7 +7302,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -7096,7 +7372,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -7163,7 +7439,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" }, "parameters": [ { @@ -7198,7 +7474,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" }, "parameters": [ { @@ -7235,9 +7511,17 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/enterprise" }, @@ -7300,7 +7584,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" }, "parameters": [ { @@ -7346,7 +7630,7 @@ "operationId": "actions/generate-runner-jitconfig-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" }, "parameters": [ { @@ -7419,7 +7703,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": false, "category": "actions", "subcategory": "self-hosted-runners" @@ -7437,7 +7721,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" }, "parameters": [ { @@ -7480,7 +7764,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" }, "parameters": [ { @@ -7523,7 +7807,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7567,7 +7851,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" }, "parameters": [ { @@ -7601,7 +7885,7 @@ "operationId": "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7636,7 +7920,7 @@ "operationId": "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7708,7 +7992,7 @@ "operationId": "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7780,7 +8064,7 @@ "operationId": "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7820,7 +8104,7 @@ "operationId": "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7863,7 +8147,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" }, "parameters": [ { @@ -7933,14 +8217,14 @@ "/enterprises/{enterprise}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an enterprise", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -8035,14 +8319,14 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/get-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -8086,7 +8370,7 @@ "operationId": "secret-scanning/patch-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -8102,24 +8386,28 @@ "properties": { "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.10/get-started/learning-about-github/about-github-advanced-security).\"" + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.14/get-started/learning-about-github/about-github-advanced-security).\"" + }, + "advanced_security_enabled_new_user_namespace_repos": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.14/get-started/learning-about-github/about-github-advanced-security).\"" }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" + "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/about-secret-scanning).\"" + "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning).\"" }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" + "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" }, "secret_scanning_push_protection_custom_link": { "type": "string", "nullable": true, - "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." + "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." } } }, @@ -8127,6 +8415,7 @@ "default": { "value": { "advanced_security_enabled_for_new_repositories": true, + "advanced_security_enabled_new_user_namespace_repos": true, "dependabot_alerts_enabled_for_new_repositories": true, "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, @@ -8160,14 +8449,14 @@ "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", - "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", + "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" }, "parameters": [ { @@ -8255,14 +8544,14 @@ "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories.", "tags": [ "secret-scanning" ], "operationId": "secret-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -8291,6 +8580,9 @@ }, { "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -8343,7 +8635,7 @@ "operationId": "billing/get-github-advanced-security-billing-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" }, "parameters": [ { @@ -8371,9 +8663,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -8395,7 +8684,7 @@ "operationId": "secret-scanning/post-security-product-enablement-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" }, "parameters": [ { @@ -8431,14 +8720,14 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-public-events" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-events" }, "parameters": [ { @@ -8489,14 +8778,14 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/feeds#get-feeds" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/feeds#get-feeds" }, "parameters": [], "responses": { @@ -8535,7 +8824,7 @@ "operationId": "gists/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#list-gists-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#list-gists-for-the-authenticated-user" }, "parameters": [ { @@ -8589,14 +8878,14 @@ }, "post": { "summary": "Create a gist", - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "description": "Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", "operationId": "gists/create", "tags": [ "gists" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#create-a-gist" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#create-a-gist" }, "parameters": [], "requestBody": { @@ -8723,14 +9012,14 @@ "/gists/public": { "get": { "summary": "List public gists", - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "tags": [ "gists" ], "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#list-public-gists" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#list-public-gists" }, "parameters": [ { @@ -8796,7 +9085,7 @@ "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#list-starred-gists" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#list-starred-gists" }, "parameters": [ { @@ -8855,14 +9144,14 @@ "/gists/{gist_id}": { "get": { "summary": "Get a gist", - "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#get-a-gist" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#get-a-gist" }, "parameters": [ { @@ -9038,7 +9327,7 @@ "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#delete-a-gist" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#delete-a-gist" }, "parameters": [ { @@ -9071,14 +9360,14 @@ "/gists/{gist_id}/comments": { "get": { "summary": "List gist comments", - "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/comments#list-gist-comments" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/comments#list-gist-comments" }, "parameters": [ { @@ -9135,14 +9424,14 @@ }, "post": { "summary": "Create a gist comment", - "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/comments#create-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/comments#create-a-gist-comment" }, "parameters": [ { @@ -9224,14 +9513,14 @@ "/gists/{gist_id}/comments/{comment_id}": { "get": { "summary": "Get a gist comment", - "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/comments#get-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/comments#get-a-gist-comment" }, "parameters": [ { @@ -9277,14 +9566,14 @@ }, "patch": { "summary": "Update a gist comment", - "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/comments#update-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/comments#update-a-gist-comment" }, "parameters": [ { @@ -9360,7 +9649,7 @@ "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/comments#delete-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/comments#delete-a-gist-comment" }, "parameters": [ { @@ -9403,7 +9692,7 @@ "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#list-gist-commits" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#list-gist-commits" }, "parameters": [ { @@ -9472,7 +9761,7 @@ "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#list-gist-forks" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#list-gist-forks" }, "parameters": [ { @@ -9536,7 +9825,7 @@ "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#fork-a-gist" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#fork-a-gist" }, "parameters": [ { @@ -9599,7 +9888,7 @@ "operationId": "gists/check-is-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#check-if-a-gist-is-starred" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#check-if-a-gist-is-starred" }, "parameters": [ { @@ -9639,14 +9928,14 @@ }, "put": { "summary": "Star a gist", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "gists" ], "operationId": "gists/star", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#star-a-gist" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#star-a-gist" }, "parameters": [ { @@ -9684,7 +9973,7 @@ "operationId": "gists/unstar", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#unstar-a-gist" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#unstar-a-gist" }, "parameters": [ { @@ -9717,14 +10006,14 @@ "/gists/{gist_id}/{sha}": { "get": { "summary": "Get a gist revision", - "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#get-a-gist-revision" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#get-a-gist-revision" }, "parameters": [ { @@ -9777,14 +10066,14 @@ "/gitignore/templates": { "get": { "summary": "Get all gitignore templates", - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-for-the-authenticated-user).", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-for-the-authenticated-user).", "operationId": "gitignore/get-all-templates", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gitignore/gitignore#get-all-gitignore-templates" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gitignore/gitignore#get-all-gitignore-templates" }, "parameters": [], "responses": { @@ -9830,14 +10119,14 @@ "/gitignore/templates/{name}": { "get": { "summary": "Get a gitignore template", - "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", + "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", "operationId": "gitignore/get-template", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gitignore/gitignore#get-a-gitignore-template" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gitignore/gitignore#get-a-gitignore-template" }, "parameters": [ { @@ -9888,7 +10177,7 @@ "operationId": "apps/list-repos-accessible-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/installations#list-repositories-accessible-to-the-app-installation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/installations#list-repositories-accessible-to-the-app-installation" }, "parameters": [ { @@ -9960,14 +10249,14 @@ "/installation/token": { "delete": { "summary": "Revoke an installation access token", - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", "tags": [ "apps" ], "operationId": "apps/revoke-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/installations#revoke-an-installation-access-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/installations#revoke-an-installation-access-token" }, "parameters": [], "responses": { @@ -9987,14 +10276,14 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -10139,14 +10428,14 @@ "/licenses": { "get": { "summary": "Get all commonly used licenses", - "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get-all-commonly-used", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/licenses/licenses#get-all-commonly-used-licenses" + "url": "https://docs.github.com/enterprise-server@3.14/rest/licenses/licenses#get-all-commonly-used-licenses" }, "parameters": [ { @@ -10199,14 +10488,14 @@ "/licenses/{license}": { "get": { "summary": "Get a license", - "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/licenses/licenses#get-a-license" + "url": "https://docs.github.com/enterprise-server@3.14/rest/licenses/licenses#get-a-license" }, "parameters": [ { @@ -10253,17 +10542,17 @@ "x-octokit": {} } }, - "/manage/v1/config/nodes": { + "/manage/v1/access/ssh": { "get": { - "summary": "Get GHES node metadata for all nodes", - "description": "Get node metadata for all configured nodes in the current cluster. For more information, see \"[About clustering](https://docs.github.com/enterprise-server@3.10/admin/enterprise-management/configuring-clustering/about-clustering).\"", - "operationId": "enterprise-admin/get-config-nodes", + "summary": "Get the configured SSH keys", + "description": "Gets the configured SSH keys on all available nodes. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/get-manage-ssh", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys" }, "servers": [ { @@ -10280,35 +10569,27 @@ } } ], - "parameters": [ - { - "$ref": "#/components/parameters/uuid" - }, - { - "$ref": "#/components/parameters/cluster-roles" - } - ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ghes-config-nodes" + "$ref": "#/components/schemas/ghes-get-ssh" }, "examples": { "default": { - "$ref": "#/components/examples/ghes-config-nodes" + "$ref": "#/components/examples/ghes-get-ssh" } } } } }, + "400": { + "description": "Bad request" + }, "401": { "description": "Unauthorized" - }, - "500": { - "description": "Internal error" } }, "x-github": { @@ -10318,19 +10599,1093 @@ "subcategory": "manage-ghes" }, "x-octokit": {} - } - }, - "/manage/v1/maintenance": { - "get": { - "summary": "Get the status of maintenance mode", - "description": "Gets the status and details of maintenance mode on all available nodes. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", - "operationId": "enterprise-admin/get-manage-maintenance", + }, + "post": { + "summary": "Set a new SSH key", + "description": "Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/set-manage-ssh", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-ssh-request" + }, + "examples": { + "default": { + "value": { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-ssh-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-set-ssh" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a SSH key", + "description": "Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/delete-manage-ssh", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#delete-a-ssh-key" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-delete-ssh-request" + }, + "examples": { + "default": { + "value": { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-delete-ssh-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-delete-ssh" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/checks/system-requirements": { + "get": { + "summary": "Get the system requirement check results for configured cluster nodes", + "description": "Checks if the minimum requirements for system hardware resources are met on each configured cluster node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-checks-system-requirements", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-system-requirement-check-results-for-configured-cluster-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-checks-system-requirements" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-checks-system-requirements" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/cluster/status": { + "get": { + "summary": "Get the status of services running on all cluster nodes", + "description": "Gets the status of all services running on each cluster node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-cluster-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-cluster-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-cluster-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-cluster-status" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/apply": { + "get": { + "summary": "Get the status of a ghe-config-apply run", + "description": "Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID.", + "operationId": "enterprise-admin/get-manage-config-apply-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run" + }, + "parameters": [ + { + "name": "run_id", + "description": "The unique run ID of the `ghe-config-apply` run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running in the environment" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful in the environment" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The unique Run ID of the ghe-config-apply run on the host" + }, + "hostname": { + "type": "string", + "description": "The hostname of the node" + }, + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running on the host" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful on the host" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "running": true, + "successful": false, + "nodes": [ + { + "run_id": "d34db33f", + "hostname": "ghes-01.lan", + "running": true, + "successful": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "post": { + "summary": "Trigger a ghe-config-apply run", + "description": "Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.", + "operationId": "enterprise-admin/post-manage-run-config-apply", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run" + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly." + } + } + }, + "examples": { + "default": { + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "Run ID the job was launched with" + } + } + }, + "examples": { + "default": { + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/apply/events": { + "get": { + "summary": "List events from ghe-config-apply", + "description": "Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance.", + "operationId": "enterprise-admin/get-manage-config-apply-events", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#list-events-from-ghe-config-apply" + }, + "parameters": [ + { + "name": "last_request_id", + "description": "The unique ID of the last response from a host, used for pagination.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "Hostname of the node" + }, + "last_request_id": { + "type": "string", + "description": "Unique ID of the last response from a host used for pagination" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "severity_text": { + "type": "string" + }, + "body": { + "type": "string" + }, + "event_name": { + "type": "string" + }, + "topology": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "config_run_id": { + "type": "string" + }, + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "span_parent_id": { + "type": "string" + }, + "span_depth": { + "type": "integer" + } + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "nodes": [ + { + "node": "ghes-01.lan", + "last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000", + "events": [ + { + "timestamp": "2023-01-01T13:00:00+00:00", + "severity_text": "INFO", + "body": "Validating services", + "event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation", + "topology": "multinode", + "hostname": "ghes-01.lan", + "config_run_id": "d34db33f", + "trace_id": "387cd628c06d606700e79be368e5e574", + "span_id": "0cde553750689c76", + "span_parent_id": 0, + "span_depth": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/init": { + "post": { + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "operationId": "enterprise-admin/initialize-instance-configuration", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ghes-config-init-request" + }, + "examples": { + "default": { + "value": { + "license": "@enterprise.ghl", + "password": "provide-password-here!" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response" + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/license": { + "get": { + "summary": "Get the enterprise license information", + "description": "Gets information about the license that is currently set for the enterprise.", + "operationId": "enterprise-admin/license-info", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-license-info" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-license-info" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "put": { + "summary": "Upload an enterprise license", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "operationId": "enterprise-admin/license-upload", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/license-apply" + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ghes-upload-license-request" + }, + "examples": { + "default": { + "value": { + "license": "@enterprise.ghl" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created" + }, + "202": { + "description": "Accepted" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/license/check": { + "get": { + "summary": "Check a license", + "description": "Check the status of the license that is currently set for the enterprise.", + "operationId": "enterprise-admin/license-check", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#check-a-license" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-license-check" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-license-check" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/nodes": { + "get": { + "summary": "Get GHES node metadata for all nodes", + "description": "Get node metadata for all configured nodes in the current cluster. For more information, see \"[About clustering](https://docs.github.com/enterprise-server@3.14/admin/enterprise-management/configuring-clustering/about-clustering).\"", + "operationId": "enterprise-admin/get-config-nodes", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/uuid" + }, + { + "$ref": "#/components/parameters/cluster-roles" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-config-nodes" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-config-nodes" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/settings": { + "get": { + "summary": "Get the GHES settings", + "description": "Gets a list of settings for a GitHub Enterprise Server instance.", + "operationId": "enterprise-admin/get-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-ghes-settings" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-get-settings" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-get-settings" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set settings", + "description": "Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-settings).\n\n**Notes:**\n- The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values.\n- You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", + "operationId": "enterprise-admin/set-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#set-settings" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "description": "Only the settings parameters that should be modified need to be specified.", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": { + "public_pages": true + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/maintenance": { + "get": { + "summary": "Get the status of maintenance mode", + "description": "Gets the status and details of maintenance mode on all available nodes. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", + "operationId": "enterprise-admin/get-manage-maintenance", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode" }, "servers": [ { @@ -10391,14 +11746,14 @@ }, "post": { "summary": "Set the status of maintenance mode", - "description": "Sets or schedules the maintenance mode. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", + "description": "Sets or schedules the maintenance mode. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", "operationId": "enterprise-admin/set-manage-maintenance", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode" }, "servers": [ { @@ -10482,7 +11837,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes" }, "servers": [ { @@ -10542,14 +11897,14 @@ "/manage/v1/version": { "get": { "summary": "Get all GHES release versions for all nodes", - "description": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.10/admin/all-releases).\"", + "description": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.14/admin/all-releases).\"", "operationId": "enterprise-admin/get-version", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes" }, "servers": [ { @@ -10616,7 +11971,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/markdown/markdown#render-a-markdown-document" + "url": "https://docs.github.com/enterprise-server@3.14/rest/markdown/markdown#render-a-markdown-document" }, "parameters": [], "requestBody": { @@ -10714,7 +12069,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" + "url": "https://docs.github.com/enterprise-server@3.14/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" }, "parameters": [], "requestBody": { @@ -10792,7 +12147,7 @@ "operationId": "meta/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/meta/meta#get-apiname-meta-information" + "url": "https://docs.github.com/enterprise-server@3.14/rest/meta/meta#get-apiname-meta-information" }, "parameters": [], "responses": { @@ -10827,14 +12182,14 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events-for-repo-network", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-public-events-for-a-network-of-repositories" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-events-for-a-network-of-repositories" }, "parameters": [ { @@ -10901,7 +12256,7 @@ "operationId": "activity/list-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -10921,7 +12276,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -10976,14 +12331,14 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#mark-notifications-as-read" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-notifications-as-read" }, "parameters": [], "requestBody": { @@ -11068,7 +12423,7 @@ "operationId": "activity/get-thread", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#get-a-thread" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#get-a-thread" }, "parameters": [ { @@ -11118,7 +12473,7 @@ "operationId": "activity/mark-thread-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#mark-a-thread-as-read" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-a-thread-as-read" }, "parameters": [ { @@ -11143,19 +12498,48 @@ "subcategory": "notifications" }, "x-octokit": {} + }, + "delete": { + "summary": "Mark a thread as done", + "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-thread-as-done", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-a-thread-as-done" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "204": { + "description": "No content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} } }, "/notifications/threads/{thread_id}/subscription": { "get": { "summary": "Get a thread subscription for the authenticated user", - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", "tags": [ "activity" ], "operationId": "activity/get-thread-subscription-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" }, "parameters": [ { @@ -11198,14 +12582,14 @@ }, "put": { "summary": "Set a thread subscription", - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#delete-a-thread-subscription) endpoint.", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#delete-a-thread-subscription) endpoint.", "tags": [ "activity" ], "operationId": "activity/set-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#set-a-thread-subscription" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#set-a-thread-subscription" }, "parameters": [ { @@ -11272,14 +12656,14 @@ }, "delete": { "summary": "Delete a thread subscription", - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "tags": [ "activity" ], "operationId": "activity/delete-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#delete-a-thread-subscription" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#delete-a-thread-subscription" }, "parameters": [ { @@ -11347,7 +12731,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/meta/meta#get-octocat" + "url": "https://docs.github.com/enterprise-server@3.14/rest/meta/meta#get-octocat" }, "x-github": { "githubCloudOnly": false, @@ -11361,14 +12745,14 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], "operationId": "orgs/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#list-organizations" }, "parameters": [ { @@ -11420,15 +12804,15 @@ }, "/organizations/{organization_id}/custom_roles": { "get": { - "summary": "Deprecated - List custom repository roles in an organization", - "description": "**Note**: This operation is deprecated and will be removed in the future.\nUse the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Closing down - List custom repository roles in an organization", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#deprecated---list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -11486,14 +12870,14 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.14/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -11530,14 +12914,14 @@ }, "patch": { "summary": "Update an organization", - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -11605,19 +12989,19 @@ }, "members_can_create_internal_repositories": { "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_private_repositories": { "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_public_repositories": { "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_allowed_repository_creation_type": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", "private", @@ -11645,27 +13029,33 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -11743,14 +13133,14 @@ }, "delete": { "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.10/site-policy/github-terms/github-terms-of-service", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.14/site-policy/github-terms/github-terms-of-service", "operationId": "orgs/delete", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { @@ -11787,7 +13177,7 @@ "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -11835,7 +13225,7 @@ "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -11904,7 +13294,7 @@ "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -11944,7 +13334,7 @@ "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -12008,7 +13398,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -12049,7 +13439,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -12109,7 +13499,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12171,7 +13561,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12235,7 +13625,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12267,7 +13657,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12301,7 +13691,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -12342,7 +13732,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -12381,14 +13771,14 @@ "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -12422,14 +13812,14 @@ }, "put": { "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -12478,7 +13868,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" }, "parameters": [ { @@ -12528,7 +13918,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12543,7 +13933,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12649,7 +14039,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12666,7 +14056,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12695,7 +14085,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12710,7 +14100,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12794,7 +14184,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12809,7 +14199,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" }, "parameters": [ { @@ -12826,7 +14216,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12843,7 +14233,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -12893,7 +14283,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12908,7 +14298,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -12958,7 +14348,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12975,7 +14365,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -12995,7 +14385,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13010,7 +14400,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -13030,7 +14420,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13047,7 +14437,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -13102,7 +14492,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13117,7 +14507,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -13167,7 +14557,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13184,7 +14574,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -13204,7 +14594,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13219,7 +14609,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -13239,7 +14629,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -13256,9 +14646,17 @@ "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/org" }, @@ -13325,7 +14723,7 @@ "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -13371,7 +14769,7 @@ "operationId": "actions/generate-runner-jitconfig-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" }, "parameters": [ { @@ -13462,7 +14860,7 @@ "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -13505,7 +14903,7 @@ "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -13548,7 +14946,7 @@ "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13592,7 +14990,7 @@ "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -13626,7 +15024,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13661,7 +15059,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13733,7 +15131,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13805,7 +15203,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13842,7 +15240,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13885,7 +15283,7 @@ "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-organization-secrets" }, "parameters": [ { @@ -13954,7 +15352,7 @@ "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -13997,7 +15395,7 @@ "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -14148,7 +15546,7 @@ "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -14182,7 +15580,7 @@ "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -14240,14 +15638,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -14266,7 +15664,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -14305,14 +15703,14 @@ "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -14348,14 +15746,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -14400,7 +15798,7 @@ "operationId": "actions/list-org-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-organization-variables" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-organization-variables" }, "parameters": [ { @@ -14467,7 +15865,7 @@ "operationId": "actions/create-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-an-organization-variable" }, "parameters": [ { @@ -14564,7 +15962,7 @@ "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { @@ -14608,7 +16006,7 @@ "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -14689,7 +16087,7 @@ "operationId": "actions/delete-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-an-organization-variable" }, "parameters": [ { @@ -14723,7 +16121,7 @@ "operationId": "actions/list-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -14791,7 +16189,7 @@ "operationId": "actions/set-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#set-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -14859,7 +16257,7 @@ "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -14902,7 +16300,7 @@ "operationId": "actions/remove-selected-repo-from-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#remove-selected-repository-from-an-organization-variable" }, "parameters": [ { @@ -14947,7 +16345,7 @@ "operationId": "announcement-banners/get-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/announcement-banners/organizations#get-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/announcement-banners/organizations#get-announcement-banner-for-organization" }, "parameters": [ { @@ -14988,7 +16386,7 @@ "operationId": "announcement-banners/set-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/announcement-banners/organizations#set-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/announcement-banners/organizations#set-announcement-banner-for-organization" }, "requestBody": { "required": true, @@ -15044,7 +16442,7 @@ "operationId": "announcement-banners/remove-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" }, "parameters": [ { @@ -15068,14 +16466,14 @@ "/orgs/{org}/audit-log": { "get": { "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "operationId": "orgs/get-audit-log", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#get-the-audit-log-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#get-the-audit-log-for-an-organization" }, "parameters": [ { @@ -15135,14 +16533,14 @@ "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -15245,14 +16643,14 @@ "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-repo-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -15299,14 +16697,14 @@ }, "post": { "summary": "Create a custom repository role", - "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/create-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#create-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#create-a-custom-repository-role" }, "parameters": [ { @@ -15370,14 +16768,14 @@ "/orgs/{org}/custom-repository-roles/{role_id}": { "get": { "summary": "Get a custom repository role", - "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/get-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#get-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#get-a-custom-repository-role" }, "parameters": [ { @@ -15417,14 +16815,14 @@ }, "patch": { "summary": "Update a custom repository role", - "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#update-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#update-a-custom-repository-role" }, "parameters": [ { @@ -15490,14 +16888,14 @@ }, "delete": { "summary": "Delete a custom repository role", - "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#delete-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#delete-a-custom-repository-role" }, "parameters": [ { @@ -15531,7 +16929,7 @@ "operationId": "dependabot/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" }, "parameters": [ { @@ -15628,7 +17026,7 @@ "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -15697,7 +17095,7 @@ "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -15740,7 +17138,7 @@ "operationId": "dependabot/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-an-organization-secret" }, "parameters": [ { @@ -15891,7 +17289,7 @@ "operationId": "dependabot/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -15925,7 +17323,7 @@ "operationId": "dependabot/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -15983,14 +17381,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -16009,7 +17407,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -16048,14 +17446,14 @@ "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -16091,14 +17489,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -16143,7 +17541,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -16188,14 +17586,14 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-organization-events" }, "parameters": [ { @@ -16240,14 +17638,14 @@ "/orgs/{org}/external-group/{group_id}": { "get": { "summary": "Get an external group", - "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/external-idp-group-info-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/external-groups#get-an-external-group" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#get-an-external-group" }, "parameters": [ { @@ -16255,6 +17653,12 @@ }, { "$ref": "#/components/parameters/group-id" + }, + { + "$ref": "#/components/parameters/members-per-page" + }, + { + "$ref": "#/components/parameters/members-page" } ], "responses": { @@ -16286,14 +17690,14 @@ "/orgs/{org}/external-groups": { "get": { "summary": "List external groups in an organization", - "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-external-idp-groups-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/external-groups#list-external-groups-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-external-groups-in-an-organization" }, "parameters": [ { @@ -16356,14 +17760,14 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#list-organization-webhooks" }, "parameters": [ { @@ -16421,7 +17825,7 @@ "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#create-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#create-an-organization-webhook" }, "parameters": [ { @@ -16470,7 +17874,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "default": [ "push" ], @@ -16558,7 +17962,7 @@ "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#get-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#get-an-organization-webhook" }, "parameters": [ { @@ -16605,7 +18009,7 @@ "operationId": "orgs/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#update-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#update-an-organization-webhook" }, "parameters": [ { @@ -16645,7 +18049,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -16710,14 +18114,14 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#delete-an-organization-webhook" }, "parameters": [ { @@ -16754,7 +18158,7 @@ "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -16798,7 +18202,7 @@ "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -16879,7 +18283,7 @@ "operationId": "orgs/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" }, "parameters": [ { @@ -16893,14 +18297,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -16948,7 +18344,7 @@ "operationId": "orgs/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -17003,7 +18399,7 @@ "operationId": "orgs/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -17039,14 +18435,14 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/webhooks#ping-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/webhooks#ping-an-organization-webhook" }, "parameters": [ { @@ -17076,14 +18472,14 @@ "/orgs/{org}/installation": { "get": { "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-org-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" }, "parameters": [ { @@ -17126,7 +18522,7 @@ "operationId": "orgs/list-app-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-app-installations-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#list-app-installations-for-an-organization" }, "parameters": [ { @@ -17188,14 +18584,14 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -17312,7 +18708,7 @@ "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#list-organization-members" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -17401,7 +18797,7 @@ "operationId": "orgs/check-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#check-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#check-organization-membership-for-a-user" }, "parameters": [ { @@ -17447,7 +18843,7 @@ "operationId": "orgs/remove-member", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#remove-an-organization-member" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#remove-an-organization-member" }, "parameters": [ { @@ -17484,7 +18880,7 @@ "operationId": "orgs/get-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#get-organization-membership-for-a-user" }, "parameters": [ { @@ -17527,14 +18923,14 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.14/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], "operationId": "orgs/set-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#set-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#set-organization-membership-for-a-user" }, "parameters": [ { @@ -17613,7 +19009,7 @@ "operationId": "orgs/remove-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#remove-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#remove-organization-membership-for-a-user" }, "parameters": [ { @@ -17653,7 +19049,7 @@ "operationId": "migrations/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/orgs#list-organization-migrations" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/orgs#list-organization-migrations" }, "parameters": [ { @@ -17717,14 +19113,14 @@ }, "post": { "summary": "Start an organization migration", - "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).\"", + "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.14/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" ], "operationId": "migrations/start-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/orgs#start-an-organization-migration" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/orgs#start-an-organization-migration" }, "parameters": [ { @@ -17855,7 +19251,7 @@ "operationId": "migrations/get-status-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/orgs#get-an-organization-migration-status" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/orgs#get-an-organization-migration-status" }, "parameters": [ { @@ -17920,7 +19316,7 @@ "operationId": "migrations/download-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/orgs#download-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/orgs#download-an-organization-migration-archive" }, "parameters": [ { @@ -17955,7 +19351,7 @@ "operationId": "migrations/delete-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/orgs#delete-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/orgs#delete-an-organization-migration-archive" }, "parameters": [ { @@ -17985,14 +19381,14 @@ "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { "delete": { "summary": "Unlock an organization repository", - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", "tags": [ "migrations" ], "operationId": "migrations/unlock-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/orgs#unlock-an-organization-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/orgs#unlock-an-organization-repository" }, "parameters": [ { @@ -18032,7 +19428,7 @@ "operationId": "migrations/list-repos-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/orgs#list-repositories-in-an-organization-migration" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/orgs#list-repositories-in-an-organization-migration" }, "parameters": [ { @@ -18085,6 +19481,758 @@ "x-octokit": {} } }, + "/orgs/{org}/organization-fine-grained-permissions": { + "get": { + "summary": "List organization fine-grained permissions for an organization", + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-organization-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-fine-grained-permission" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-fine-grained-permission-example" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles": { + "get": { + "summary": "Get all organization roles for an organization", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-roles", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response - list of organization roles", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of organization roles available to the organization." + }, + "roles": { + "type": "array", + "description": "The list of organization roles available to the organization.", + "items": { + "$ref": "#/components/schemas/organization-role" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-role-list" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a custom organization role", + "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-custom-organization-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#create-a-custom-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-organization-role-create-schema" + }, + "examples": { + "default": { + "value": { + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-role" + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:19:11Z" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}": { + "delete": { + "summary": "Remove all organization roles for a team", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + "put": { + "summary": "Assign an organization role to a team", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-team-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, team or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled for the organization, or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove an organization role from a team", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/users/{username}": { + "delete": { + "summary": "Remove all organization roles for a user", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + "put": { + "summary": "Assign an organization role to a user", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-user-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#assign-an-organization-role-to-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, user or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove an organization role from a user", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#remove-an-organization-role-from-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/{role_id}": { + "get": { + "summary": "Get an organization role", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#get-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-role" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-role" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a custom organization role", + "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/patch-custom-organization-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#update-a-custom-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-organization-role-update-schema" + }, + "examples": { + "default": { + "value": { + "description": "Permissions to manage custom roles within an org." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-role" + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:19:11Z" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a custom organization role.", + "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-custom-organization-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#delete-a-custom-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/{role_id}/teams": { + "get": { + "summary": "List teams that are assigned to an organization role", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response - List of assigned teams", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of teams assigned to the organization role", + "items": { + "$ref": "#/components/schemas/team-role-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/{role_id}/users": { + "get": { + "summary": "List users that are assigned to an organization role", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response - List of assigned users", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of users assigned to the organization role", + "items": { + "$ref": "#/components/schemas/user-role-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, "/orgs/{org}/outside_collaborators": { "get": { "summary": "List outside collaborators for an organization", @@ -18095,7 +20243,7 @@ "operationId": "orgs/list-outside-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" }, "parameters": [ { @@ -18159,14 +20307,14 @@ "/orgs/{org}/outside_collaborators/{username}": { "put": { "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.10/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.14/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "tags": [ "orgs" ], "operationId": "orgs/convert-member-to-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" }, "parameters": [ { @@ -18227,7 +20375,7 @@ "description": "User was converted" }, "403": { - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" }, "404": { "$ref": "#/components/responses/not_found" @@ -18250,7 +20398,7 @@ "operationId": "orgs/remove-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" }, "parameters": [ { @@ -18283,7 +20431,7 @@ "response-if-user-is-a-member-of-the-organization": { "value": { "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" } } } @@ -18303,14 +20451,14 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#list-packages-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#list-packages-for-an-organization" }, "parameters": [ { @@ -18338,7 +20486,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -18347,7 +20495,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -18396,14 +20544,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-a-package-for-an-organization" }, "parameters": [ { @@ -18443,14 +20591,14 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#delete-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#delete-a-package-for-an-organization" }, "parameters": [ { @@ -18489,14 +20637,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#restore-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#restore-a-package-for-an-organization" }, "parameters": [ { @@ -18544,14 +20692,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ { @@ -18635,14 +20783,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-a-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-a-package-version-for-an-organization" }, "parameters": [ { @@ -18685,14 +20833,14 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#delete-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#delete-package-version-for-an-organization" }, "parameters": [ { @@ -18734,14 +20882,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#restore-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#restore-package-version-for-an-organization" }, "parameters": [ { @@ -18790,7 +20938,7 @@ "operationId": "orgs/list-pat-grant-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -18878,7 +21026,7 @@ "operationId": "orgs/review-pat-grant-requests-in-bulk", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -18972,7 +21120,7 @@ "operationId": "orgs/review-pat-grant-request", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -19062,7 +21210,7 @@ "operationId": "orgs/list-pat-grant-request-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" }, "parameters": [ { @@ -19137,7 +21285,7 @@ "operationId": "orgs/list-pat-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" }, "parameters": [ { @@ -19225,7 +21373,7 @@ "operationId": "orgs/update-pat-accesses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" }, "parameters": [ { @@ -19313,7 +21461,7 @@ "operationId": "orgs/update-pat-access", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" }, "parameters": [ { @@ -19389,7 +21537,7 @@ "operationId": "orgs/list-pat-grant-repositories", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" }, "parameters": [ { @@ -19464,7 +21612,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization" }, "parameters": [ { @@ -19534,7 +21682,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization" }, "parameters": [ { @@ -19578,7 +21726,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization" }, "parameters": [ { @@ -19650,7 +21798,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization" }, "parameters": [ { @@ -19696,7 +21844,7 @@ "operationId": "projects/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#list-organization-projects" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#list-organization-projects" }, "parameters": [ { @@ -19769,7 +21917,7 @@ "operationId": "projects/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#create-an-organization-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#create-an-organization-project" }, "parameters": [ { @@ -19848,6 +21996,472 @@ "x-octokit": {} } }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-all-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-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/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-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/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" + ], + "values_editable_by": "org_actors" + }, + { + "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/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-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/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-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": { + "$ref": "#/components/schemas/custom-property-set-payload" + }, + "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/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-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": "custom-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-server@3.14/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "repository_query", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.14/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "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": "custom-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\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-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": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + }, + "x-octokit": {} + } + }, "/orgs/{org}/public_members": { "get": { "summary": "List public organization members", @@ -19858,7 +22472,7 @@ "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#list-public-organization-members" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#list-public-organization-members" }, "parameters": [ { @@ -19915,7 +22529,7 @@ "operationId": "orgs/check-public-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#check-public-organization-membership-for-a-user" }, "parameters": [ { @@ -19943,14 +22557,14 @@ }, "put": { "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "orgs" ], "operationId": "orgs/set-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -19985,7 +22599,7 @@ "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -20012,14 +22626,14 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-organization-repositories" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-organization-repositories" }, "parameters": [ { @@ -20121,7 +22735,7 @@ "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-an-organization-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-an-organization-repository" }, "parameters": [ { @@ -20154,7 +22768,7 @@ }, "visibility": { "type": "string", - "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.10/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.14/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -20202,7 +22816,7 @@ }, "license_template": { "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.10/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.14/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." }, "allow_squash_merge": { "type": "boolean", @@ -20231,7 +22845,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -20241,7 +22855,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -20258,7 +22872,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -20268,6 +22882,11 @@ "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "custom_properties": { + "type": "object", + "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -20333,14 +22952,14 @@ "/orgs/{org}/repository-fine-grained-permissions": { "get": { "summary": "List repository fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-repo-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -20376,6 +22995,591 @@ "x-octokit": {} } }, + "/orgs/{org}/rulesets": { + "get": { + "summary": "Get all organization repository rulesets", + "description": "Get all the repository rulesets for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rulesets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/rules#get-all-organization-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/ruleset-targets" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "post": { + "summary": "Create an organization repository ruleset", + "description": "Create a repository ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/create-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/rules#create-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset.", + "enum": [ + "branch", + "tag", + "push" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/org-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "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-server@3.14/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-server@3.14/rest/orgs/rule-suites#list-organization-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/ref-in-query" + }, + { + "$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-server@3.14/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-server@3.14/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", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/rules#get-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "put": { + "summary": "Update an organization repository ruleset", + "description": "Update a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/update-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/rules#update-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset.", + "enum": [ + "branch", + "tag", + "push" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/org-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an organization repository ruleset", + "description": "Delete a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/rules#delete-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + } + }, "/orgs/{org}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an organization", @@ -20386,7 +23590,7 @@ "operationId": "secret-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -20418,6 +23622,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -20463,14 +23670,14 @@ "/orgs/{org}/security-managers": { "get": { "summary": "List security manager teams", - "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-security-manager-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/security-managers#list-security-manager-teams" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/security-managers#list-security-manager-teams" }, "parameters": [ { @@ -20510,14 +23717,14 @@ "/orgs/{org}/security-managers/teams/{team_slug}": { "put": { "summary": "Add a security manager team", - "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/add-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/security-managers#add-a-security-manager-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/security-managers#add-a-security-manager-team" }, "parameters": [ { @@ -20530,9 +23737,6 @@ "responses": { "204": { "description": "Response" - }, - "409": { - "description": "The organization has reached the maximum number of security manager teams." } }, "x-github": { @@ -20546,14 +23750,14 @@ }, "delete": { "summary": "Remove a security manager team", - "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/remove-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/security-managers#remove-a-security-manager-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/security-managers#remove-a-security-manager-team" }, "parameters": [ { @@ -20588,7 +23792,7 @@ "operationId": "billing/get-github-advanced-security-billing-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" }, "parameters": [ { @@ -20616,9 +23820,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -20640,7 +23841,7 @@ "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-teams" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-teams" }, "parameters": [ { @@ -20691,14 +23892,14 @@ }, "post": { "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.10/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.14/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team" }, "parameters": [ { @@ -20752,7 +23953,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push" @@ -20765,7 +23966,7 @@ }, "ldap_dn": { "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"" + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"" } }, "required": [ @@ -20821,14 +24022,14 @@ "/orgs/{org}/teams/{team_slug}": { "get": { "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#get-a-team-by-name" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name" }, "parameters": [ { @@ -20868,14 +24069,14 @@ }, "patch": { "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#update-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team" }, "parameters": [ { @@ -20918,7 +24119,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -20997,14 +24198,14 @@ }, "delete": { "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/delete-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#delete-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team" }, "parameters": [ { @@ -21031,14 +24232,14 @@ "/orgs/{org}/teams/{team_slug}/discussions": { "get": { "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#list-discussions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions" }, "parameters": [ { @@ -21101,14 +24302,14 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#create-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion" }, "parameters": [ { @@ -21185,14 +24386,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion" }, "parameters": [ { @@ -21232,14 +24433,14 @@ }, "patch": { "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#update-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion" }, "parameters": [ { @@ -21306,14 +24507,14 @@ }, "delete": { "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#delete-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion" }, "parameters": [ { @@ -21343,14 +24544,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussion-comments-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#list-discussion-comments" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments" }, "parameters": [ { @@ -21407,14 +24608,14 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#create-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment" }, "parameters": [ { @@ -21483,14 +24684,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment" }, "parameters": [ { @@ -21533,14 +24734,14 @@ }, "patch": { "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#update-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment" }, "parameters": [ { @@ -21609,14 +24810,14 @@ }, "delete": { "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#delete-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment" }, "parameters": [ { @@ -21649,14 +24850,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" }, "parameters": [ { @@ -21673,7 +24874,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", "required": false, "schema": { @@ -21732,14 +24933,14 @@ }, "post": { "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" }, "parameters": [ { @@ -21764,7 +24965,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "enum": [ "+1", "-1", @@ -21835,14 +25036,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/delete-for-team-discussion-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-team-discussion-comment-reaction" }, "parameters": [ { @@ -21878,14 +25079,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion" }, "parameters": [ { @@ -21899,7 +25100,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "query", "required": false, "schema": { @@ -21958,14 +25159,14 @@ }, "post": { "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion" }, "parameters": [ { @@ -21987,7 +25188,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ "+1", "-1", @@ -22058,14 +25259,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/delete-for-team-discussion", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-team-discussion-reaction" }, "parameters": [ { @@ -22098,14 +25299,14 @@ "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -22142,14 +25343,14 @@ }, "patch": { "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/link-external-idp-group-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -22213,14 +25414,14 @@ }, "delete": { "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/unlink-external-idp-group-from-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -22254,7 +25455,7 @@ "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members" }, "parameters": [ { @@ -22322,14 +25523,14 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user" }, "parameters": [ { @@ -22372,14 +25573,14 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -22454,14 +25655,14 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -22494,14 +25695,14 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "tags": [ "teams" ], "operationId": "teams/list-projects-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects" }, "parameters": [ { @@ -22554,14 +25755,14 @@ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project" }, "parameters": [ { @@ -22604,14 +25805,14 @@ }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-project-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions" }, "parameters": [ { @@ -22633,7 +25834,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "enum": [ "read", "write", @@ -22677,7 +25878,7 @@ "response-if-the-project-is-not-owned-by-the-organization": { "value": { "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions" + "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions" } } } @@ -22695,14 +25896,14 @@ }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/remove-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-project-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team" }, "parameters": [ { @@ -22732,14 +25933,14 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -22792,14 +25993,14 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -22848,14 +26049,14 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -22880,8 +26081,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "default": "push" + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." } } }, @@ -22911,14 +26111,14 @@ }, "delete": { "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -22951,14 +26151,14 @@ "/orgs/{org}/teams/{team_slug}/teams": { "get": { "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -23011,14 +26211,14 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -23031,6 +26231,30 @@ "$ref": "#/components/parameters/org-security-product-enablement" } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" + ] + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, "responses": { "204": { "description": "Action started" @@ -23044,8 +26268,11 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "orgs" + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" }, + "deprecated": true, "x-octokit": {} } }, @@ -23059,7 +26286,7 @@ "operationId": "projects/get-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/cards#get-a-project-card" }, "parameters": [ { @@ -23112,7 +26339,7 @@ "operationId": "projects/update-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/cards#update-an-existing-project-card" }, "parameters": [ { @@ -23199,7 +26426,7 @@ "operationId": "projects/delete-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/cards#delete-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/cards#delete-a-project-card" }, "parameters": [ { @@ -23263,7 +26490,7 @@ "operationId": "projects/move-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/cards#move-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/cards#move-a-project-card" }, "parameters": [ { @@ -23425,7 +26652,7 @@ "operationId": "projects/get-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/columns#get-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/columns#get-a-project-column" }, "parameters": [ { @@ -23478,7 +26705,7 @@ "operationId": "projects/update-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/columns#update-an-existing-project-column" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/columns#update-an-existing-project-column" }, "parameters": [ { @@ -23556,7 +26783,7 @@ "operationId": "projects/delete-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/columns#delete-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/columns#delete-a-project-column" }, "parameters": [ { @@ -23596,7 +26823,7 @@ "operationId": "projects/list-cards", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/cards#list-project-cards" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/cards#list-project-cards" }, "parameters": [ { @@ -23675,7 +26902,7 @@ "operationId": "projects/create-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/cards#create-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/cards#create-a-project-card" }, "parameters": [ { @@ -23831,7 +27058,7 @@ "operationId": "projects/move-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/columns#move-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/columns#move-a-project-column" }, "parameters": [ { @@ -23917,7 +27144,7 @@ "operationId": "projects/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#get-a-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#get-a-project" }, "parameters": [ { @@ -23967,7 +27194,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#update-a-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#update-a-project" }, "parameters": [ { @@ -24099,7 +27326,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#delete-a-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#delete-a-project" }, "parameters": [ { @@ -24166,7 +27393,7 @@ "operationId": "projects/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/collaborators#list-project-collaborators" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#list-project-collaborators" }, "parameters": [ { @@ -24253,7 +27480,7 @@ "operationId": "projects/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/collaborators#add-project-collaborator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#add-project-collaborator" }, "parameters": [ { @@ -24332,7 +27559,7 @@ "operationId": "projects/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/collaborators#remove-user-as-a-collaborator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#remove-user-as-a-collaborator" }, "parameters": [ { @@ -24381,7 +27608,7 @@ "operationId": "projects/get-permission-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/collaborators#get-project-permission-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#get-project-permission-for-a-user" }, "parameters": [ { @@ -24442,7 +27669,7 @@ "operationId": "projects/list-columns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/columns#list-project-columns" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/columns#list-project-columns" }, "parameters": [ { @@ -24506,7 +27733,7 @@ "operationId": "projects/create-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/columns#create-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/columns#create-a-project-column" }, "parameters": [ { @@ -24590,14 +27817,14 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.10/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.10/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.10/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.10/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.14/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.14/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.14/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.14/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.14/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.14/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, "parameters": [], "responses": { @@ -24646,14 +27873,14 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository" }, "parameters": [ { @@ -24699,14 +27926,14 @@ }, "patch": { "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#replace-all-repository-topics) endpoint.", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics) endpoint.", "tags": [ "repos" ], "operationId": "repos/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#update-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#update-a-repository" }, "parameters": [ { @@ -24737,7 +27964,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.14/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -24751,7 +27978,7 @@ }, "security_and_analysis": { "type": "object", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "nullable": true, "properties": { "advanced_security": { @@ -24837,7 +28064,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -24847,7 +28074,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -24864,7 +28091,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -24946,12 +28173,12 @@ { "required": false, "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.10/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.14/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" }, { "required": false, "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -24966,7 +28193,7 @@ "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#delete-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository" }, "parameters": [ { @@ -25002,7 +28229,7 @@ "default": { "value": { "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#delete-a-repository" + "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository" } } } @@ -25032,7 +28259,7 @@ "operationId": "actions/list-artifacts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/artifacts#list-artifacts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-artifacts-for-a-repository" }, "parameters": [ { @@ -25107,7 +28334,7 @@ "operationId": "actions/get-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/artifacts#get-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#get-an-artifact" }, "parameters": [ { @@ -25154,7 +28381,7 @@ "operationId": "actions/delete-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/artifacts#delete-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#delete-an-artifact" }, "parameters": [ { @@ -25191,7 +28418,7 @@ "operationId": "actions/download-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/artifacts#download-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#download-an-artifact" }, "parameters": [ { @@ -25244,7 +28471,7 @@ "operationId": "actions/get-actions-cache-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" }, "parameters": [ { @@ -25290,7 +28517,7 @@ "operationId": "actions/get-actions-cache-usage-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository" }, "parameters": [ { @@ -25334,7 +28561,7 @@ "operationId": "actions/set-actions-cache-usage-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository" }, "parameters": [ { @@ -25383,7 +28610,7 @@ "operationId": "actions/get-actions-cache-list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#list-github-actions-caches-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#list-github-actions-caches-for-a-repository" }, "parameters": [ { @@ -25451,7 +28678,7 @@ "operationId": "actions/delete-actions-cache-by-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" }, "parameters": [ { @@ -25503,7 +28730,7 @@ "operationId": "actions/delete-actions-cache-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" }, "parameters": [ { @@ -25540,7 +28767,7 @@ "operationId": "actions/get-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" }, "parameters": [ { @@ -25589,7 +28816,7 @@ "operationId": "actions/download-job-logs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" }, "parameters": [ { @@ -25634,7 +28861,7 @@ "operationId": "actions/re-run-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" }, "parameters": [ { @@ -25709,7 +28936,7 @@ "operationId": "actions/get-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -25759,7 +28986,7 @@ "operationId": "actions/set-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -25853,7 +29080,7 @@ "operationId": "actions/list-repo-organization-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-repository-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-organization-secrets" }, "parameters": [ { @@ -25925,7 +29152,7 @@ "operationId": "actions/list-repo-organization-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-repository-organization-variables" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-organization-variables" }, "parameters": [ { @@ -25997,7 +29224,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -26051,7 +29278,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -26107,14 +29334,14 @@ "/repos/{owner}/{repo}/actions/permissions/access": { "get": { "summary": "Get the level of access for workflows outside of the repository", - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -26152,14 +29379,14 @@ }, "put": { "summary": "Set the level of access for workflows outside of the repository", - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -26209,7 +29436,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -26253,7 +29480,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -26295,14 +29522,14 @@ "/repos/{owner}/{repo}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for a repository", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -26339,14 +29566,14 @@ }, "put": { "summary": "Set default workflow permissions for a repository", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -26398,9 +29625,17 @@ "operationId": "actions/list-self-hosted-runners-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/owner" }, @@ -26470,7 +29705,7 @@ "operationId": "actions/list-runner-applications-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" }, "parameters": [ { @@ -26519,7 +29754,7 @@ "operationId": "actions/generate-runner-jitconfig-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" }, "parameters": [ { @@ -26613,7 +29848,7 @@ "operationId": "actions/create-registration-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" }, "parameters": [ { @@ -26659,7 +29894,7 @@ "operationId": "actions/create-remove-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" }, "parameters": [ { @@ -26705,7 +29940,7 @@ "operationId": "actions/get-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -26752,7 +29987,7 @@ "operationId": "actions/delete-self-hosted-runner-from-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" }, "parameters": [ { @@ -26789,7 +30024,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -26827,7 +30062,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -26902,7 +30137,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -26977,7 +30212,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27017,7 +30252,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -27056,14 +30291,14 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" }, "parameters": [ { @@ -27159,7 +30394,7 @@ "operationId": "actions/get-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#get-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run" }, "parameters": [ { @@ -27209,7 +30444,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#delete-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-a-workflow-run" }, "parameters": [ { @@ -27246,7 +30481,7 @@ "operationId": "actions/get-reviews-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" }, "parameters": [ { @@ -27298,7 +30533,7 @@ "operationId": "actions/list-workflow-run-artifacts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/artifacts#list-workflow-run-artifacts" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/artifacts#list-workflow-run-artifacts" }, "parameters": [ { @@ -27376,7 +30611,7 @@ "operationId": "actions/get-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#get-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-a-workflow-run-attempt" }, "parameters": [ { @@ -27424,14 +30659,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { "get": { "summary": "List jobs for a workflow run attempt", - "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" }, "parameters": [ { @@ -27512,7 +30747,7 @@ "operationId": "actions/download-workflow-run-attempt-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#download-workflow-run-attempt-logs" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-attempt-logs" }, "parameters": [ { @@ -27560,7 +30795,7 @@ "operationId": "actions/cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#cancel-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#cancel-a-workflow-run" }, "parameters": [ { @@ -27605,14 +30840,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { "post": { "summary": "Review custom deployment protection rules for a workflow run", - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/review-custom-gates-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" }, "parameters": [ { @@ -27666,17 +30901,69 @@ "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\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/force-cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/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", - "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" }, "parameters": [ { @@ -27765,7 +31052,7 @@ "operationId": "actions/download-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#download-workflow-run-logs" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#download-workflow-run-logs" }, "parameters": [ { @@ -27808,7 +31095,7 @@ "operationId": "actions/delete-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#delete-workflow-run-logs" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#delete-workflow-run-logs" }, "parameters": [ { @@ -27851,7 +31138,7 @@ "operationId": "actions/get-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -27901,7 +31188,7 @@ "operationId": "actions/review-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -28007,7 +31294,7 @@ "operationId": "actions/re-run-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-workflow" }, "parameters": [ { @@ -28079,7 +31366,7 @@ "operationId": "actions/re-run-workflow-failed-jobs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" }, "parameters": [ { @@ -28151,7 +31438,7 @@ "operationId": "actions/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-repository-secrets" }, "parameters": [ { @@ -28223,7 +31510,7 @@ "operationId": "actions/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -28269,7 +31556,7 @@ "operationId": "actions/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-secret" }, "parameters": [ { @@ -28309,14 +31596,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -28338,7 +31625,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -28395,7 +31682,7 @@ "operationId": "actions/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -28432,7 +31719,7 @@ "operationId": "actions/list-repo-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-repository-variables" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-repository-variables" }, "parameters": [ { @@ -28502,7 +31789,7 @@ "operationId": "actions/create-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-a-repository-variable" }, "parameters": [ { @@ -28580,7 +31867,7 @@ "operationId": "actions/get-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-a-repository-variable" }, "parameters": [ { @@ -28627,7 +31914,7 @@ "operationId": "actions/update-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-a-repository-variable" }, "parameters": [ { @@ -28690,7 +31977,7 @@ "operationId": "actions/delete-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-a-repository-variable" }, "parameters": [ { @@ -28727,7 +32014,7 @@ "operationId": "actions/list-repo-workflows", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflows#list-repository-workflows" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#list-repository-workflows" }, "parameters": [ { @@ -28799,7 +32086,7 @@ "operationId": "actions/get-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflows#get-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#get-a-workflow" }, "parameters": [ { @@ -28848,7 +32135,7 @@ "operationId": "actions/disable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflows#disable-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#disable-a-workflow" }, "parameters": [ { @@ -28885,7 +32172,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflows#create-a-workflow-dispatch-event" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#create-a-workflow-dispatch-event" }, "parameters": [ { @@ -28958,7 +32245,7 @@ "operationId": "actions/enable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflows#enable-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflows#enable-a-workflow" }, "parameters": [ { @@ -28988,14 +32275,14 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs for a workflow", - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" }, "parameters": [ { @@ -29084,17 +32371,137 @@ "x-octokit": {} } }, + "/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 activity and data for your repository](https://docs.github.com/enterprise-server@3.14/repositories/viewing-activity-and-data-for-your-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/list-activities", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-activities" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "ref", + "description": "The Git reference for the activities you want to list.\n\nThe `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "actor", + "description": "The GitHub username to use to filter by the actor who performed the activity.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "day", + "week", + "month", + "quarter", + "year" + ] + } + }, + { + "name": "activity_type", + "description": "The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "push", + "force_push", + "branch_creation", + "branch_deletion", + "pr_merge", + "merge_queue_merge" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/activity" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/activity-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/assignees": { "get": { "summary": "List assignees", - "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.10/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.14/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "tags": [ "issues" ], "operationId": "issues/list-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/assignees#list-assignees" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#list-assignees" }, "parameters": [ { @@ -29157,7 +32564,7 @@ "operationId": "issues/check-user-can-be-assigned", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/assignees#check-if-a-user-can-be-assigned" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned" }, "parameters": [ { @@ -29209,7 +32616,7 @@ "operationId": "repos/list-autolinks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/autolinks#get-all-autolinks-of-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-all-autolinks-of-a-repository" }, "parameters": [ { @@ -29256,7 +32663,7 @@ "operationId": "repos/create-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" }, "parameters": [ { @@ -29351,7 +32758,7 @@ "operationId": "repos/get-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" }, "parameters": [ { @@ -29401,7 +32808,7 @@ "operationId": "repos/delete-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" }, "parameters": [ { @@ -29434,14 +32841,14 @@ "/repos/{owner}/{repo}/automated-security-fixes": { "get": { "summary": "Check if automated security fixes are enabled for a repository", - "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.10/articles/configuring-automated-security-fixes)\".", + "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.14/articles/configuring-automated-security-fixes)\".", "tags": [ "repos" ], "operationId": "repos/check-automated-security-fixes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository" }, "parameters": [ { @@ -29453,7 +32860,7 @@ ], "responses": { "200": { - "description": "Response if dependabot is enabled", + "description": "Response if Dependabot is enabled", "content": { "application/json": { "schema": { @@ -29471,7 +32878,7 @@ } }, "404": { - "description": "Not Found if dependabot is not enabled for the repository" + "description": "Not Found if Dependabot is not enabled for the repository" } }, "x-github": { @@ -29493,7 +32900,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branches#list-branches" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branches#list-branches" }, "parameters": [ { @@ -29504,7 +32911,7 @@ }, { "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "description": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", "required": false, "schema": { @@ -29565,7 +32972,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branches#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -29613,14 +33020,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection": { "get": { "summary": "Get branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -29663,14 +33070,14 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -29702,7 +33109,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -29776,7 +33183,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.10/articles/about-code-owners/) review them." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.14/articles/about-code-owners/) review them." }, "required_approving_review_count": { "type": "integer", @@ -29850,16 +33257,16 @@ }, "required_linear_history": { "type": "boolean", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." }, "allow_force_pushes": { "type": "boolean", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "nullable": true }, "allow_deletions": { "type": "boolean", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." }, "block_creations": { "type": "boolean", @@ -29979,14 +33386,14 @@ }, "delete": { "summary": "Delete branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -30019,14 +33426,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { "get": { "summary": "Get admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -30066,14 +33473,14 @@ }, "post": { "summary": "Set admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -30113,14 +33520,14 @@ }, "delete": { "summary": "Delete admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -30153,14 +33560,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { "get": { "summary": "Get pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -30200,14 +33607,14 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -30260,7 +33667,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.10/articles/about-code-owners/) have reviewed." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.14/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { "type": "integer", @@ -30365,14 +33772,14 @@ }, "delete": { "summary": "Delete pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -30405,14 +33812,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.10/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.14/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -30455,14 +33862,14 @@ }, "post": { "summary": "Create commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -30505,14 +33912,14 @@ }, "delete": { "summary": "Delete commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -30545,14 +33952,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { "get": { "summary": "Get status checks protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -30595,14 +34002,14 @@ }, "patch": { "summary": "Update status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -30629,7 +34036,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -30712,14 +34119,14 @@ }, "delete": { "summary": "Remove status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -30749,14 +34156,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { "get": { "summary": "Get all status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -30804,14 +34211,14 @@ }, "post": { "summary": "Add status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -30909,14 +34316,14 @@ }, "put": { "summary": "Set status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -31009,14 +34416,14 @@ }, "delete": { "summary": "Remove status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -31110,14 +34517,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -31160,14 +34567,14 @@ }, "delete": { "summary": "Delete access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "tags": [ "repos" ], "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -31197,14 +34604,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { "get": { "summary": "Get apps with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -31250,14 +34657,14 @@ }, "post": { "summary": "Add app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -31271,32 +34678,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -31344,14 +34747,14 @@ }, "put": { "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -31365,32 +34768,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -31438,14 +34837,14 @@ }, "delete": { "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -31459,31 +34858,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -31533,14 +34929,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { "get": { "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -31586,14 +34982,14 @@ }, "post": { "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", "tags": [ "repos" ], "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -31681,14 +35077,14 @@ }, "put": { "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", "tags": [ "repos" ], "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -31776,14 +35172,14 @@ }, "delete": { "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", "tags": [ "repos" ], "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -31872,14 +35268,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { "get": { "summary": "Get users with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "tags": [ "repos" ], "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -31925,14 +35321,14 @@ }, "post": { "summary": "Add user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -31946,32 +35342,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -32020,14 +35412,14 @@ }, "put": { "summary": "Set user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -32041,32 +35433,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -32115,14 +35503,14 @@ }, "delete": { "summary": "Remove user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/remove-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection#remove-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection#remove-user-access-restrictions" }, "parameters": [ { @@ -32136,31 +35524,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -32211,14 +35596,14 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branches#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -32613,14 +35998,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}": { "get": { "summary": "Get a check run", - "description": "Gets a single check run using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/runs#get-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/runs#get-a-check-run" }, "parameters": [ { @@ -32660,14 +36045,14 @@ }, "patch": { "summary": "Update a check run", - "description": "Updates a check run for a specific commit in a 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/runs#update-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/runs#update-a-check-run" }, "parameters": [ { @@ -32755,7 +36140,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.10/articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.14/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.14/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -32843,7 +36228,7 @@ }, "actions": { "type": "array", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.10/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.14/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -32980,7 +36365,7 @@ "operationId": "checks/list-annotations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/runs#list-check-run-annotations" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-run-annotations" }, "parameters": [ { @@ -33036,14 +36421,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/rerequest-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/runs#rerequest-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/runs#rerequest-a-check-run" }, "parameters": [ { @@ -33108,14 +36493,14 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.14/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/create-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/suites#create-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite" }, "parameters": [ { @@ -33195,14 +36580,14 @@ "/repos/{owner}/{repo}/check-suites/preferences": { "patch": { "summary": "Update repository preferences for check suites", - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", "tags": [ "checks" ], "operationId": "checks/set-suites-preferences", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/suites#update-repository-preferences-for-check-suites" }, "parameters": [ { @@ -33287,14 +36672,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { "get": { "summary": "Get a check suite", - "description": "Gets a single check suite using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/get-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite" }, "parameters": [ { @@ -33336,14 +36721,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "Lists check runs for a check suite using its `id`.\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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/runs#list-check-runs-in-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-in-a-check-suite" }, "parameters": [ { @@ -33431,14 +36816,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { "post": { "summary": "Rerequest a check suite", - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/suites#rerequest-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/suites#rerequest-a-check-suite" }, "parameters": [ { @@ -33487,7 +36872,7 @@ "operationId": "code-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -33598,7 +36983,7 @@ "operationId": "code-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#get-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-alert" }, "parameters": [ { @@ -33668,7 +37053,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#update-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-alert" }, "parameters": [ { @@ -33759,7 +37144,7 @@ "operationId": "code-scanning/list-alert-instances", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" }, "parameters": [ { @@ -33832,14 +37217,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses": { "get": { "summary": "List code scanning analyses for a repository", - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/list-recent-analyses", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" }, "parameters": [ { @@ -33936,14 +37321,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" }, "parameters": [ { @@ -34016,7 +37401,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" }, "parameters": [ { @@ -34093,7 +37478,7 @@ "operationId": "code-scanning/get-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -34146,7 +37531,7 @@ "operationId": "code-scanning/update-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -34227,14 +37612,14 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" }, "parameters": [ { @@ -34346,7 +37731,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" + "url": "https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" }, "parameters": [ { @@ -34403,14 +37788,14 @@ "/repos/{owner}/{repo}/codeowners/errors": { "get": { "summary": "List CODEOWNERS errors", - "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", + "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", "tags": [ "repos" ], "operationId": "repos/codeowners-errors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-codeowners-errors" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-codeowners-errors" }, "parameters": [ { @@ -34469,7 +37854,7 @@ "operationId": "repos/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators#list-repository-collaborators" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#list-repository-collaborators" }, "parameters": [ { @@ -34563,7 +37948,7 @@ "operationId": "repos/check-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" }, "parameters": [ { @@ -34594,14 +37979,14 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", + "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", "tags": [ "repos" ], "operationId": "repos/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators#add-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#add-a-repository-collaborator" }, "parameters": [ { @@ -34661,14 +38046,14 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n**Note**: A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], "operationId": "repos/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators#remove-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#remove-a-repository-collaborator" }, "parameters": [ { @@ -34711,7 +38096,7 @@ "operationId": "repos/get-collaborator-permission-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators#get-repository-permissions-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators#get-repository-permissions-for-a-user" }, "parameters": [ { @@ -34756,14 +38141,14 @@ "/repos/{owner}/{repo}/comments": { "get": { "summary": "List commit comments for a repository", - "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-commit-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/comments#list-commit-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments-for-a-repository" }, "parameters": [ { @@ -34816,14 +38201,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}": { "get": { "summary": "Get a commit comment", - "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/get-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment" }, "parameters": [ { @@ -34866,14 +38251,14 @@ }, "patch": { "summary": "Update a commit comment", - "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/update-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/comments#update-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/comments#update-a-commit-comment" }, "parameters": [ { @@ -34949,7 +38334,7 @@ "operationId": "repos/delete-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/comments#delete-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/comments#delete-a-commit-comment" }, "parameters": [ { @@ -34982,14 +38367,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a commit comment", - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment).", + "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-commit-comment" }, "parameters": [ { @@ -35003,7 +38388,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", "in": "query", "required": false, "schema": { @@ -35065,14 +38450,14 @@ }, "post": { "summary": "Create reaction for a commit comment", - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", + "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-commit-comment" }, "parameters": [ { @@ -35094,7 +38479,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the commit comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the commit comment.", "enum": [ "+1", "-1", @@ -35168,14 +38553,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#delete-a-commit-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-commit-comment-reaction" }, "parameters": [ { @@ -35208,14 +38593,14 @@ "/repos/{owner}/{repo}/commits": { "get": { "summary": "List commits", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits" }, "parameters": [ { @@ -35261,11 +38646,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -35329,14 +38721,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { "get": { "summary": "List branches for HEAD commit", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "tags": [ "repos" ], "operationId": "repos/list-branches-for-head-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-branches-for-head-commit" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-branches-for-head-commit" }, "parameters": [ { @@ -35387,14 +38779,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { "get": { "summary": "List commit comments", - "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-comments-for-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/comments#list-commit-comments" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/comments#list-commit-comments" }, "parameters": [ { @@ -35448,14 +38840,14 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/create-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/comments#create-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/comments#create-a-commit-comment" }, "parameters": [ { @@ -35489,7 +38881,7 @@ }, "line": { "type": "integer", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." + "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ @@ -35560,7 +38952,7 @@ "operationId": "repos/list-pull-requests-associated-with-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-pull-requests-associated-with-a-commit" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-pull-requests-associated-with-a-commit" }, "parameters": [ { @@ -35619,14 +39011,14 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/commits#get-a-commit" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/commits#get-a-commit" }, "parameters": [ { @@ -35689,14 +39081,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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.14/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.14/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/runs#list-check-runs-for-a-git-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/runs#list-check-runs-for-a-git-reference" }, "parameters": [ { @@ -35792,14 +39184,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-suites-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/checks/suites#list-check-suites-for-a-git-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/checks/suites#list-check-suites-for-a-git-reference" }, "parameters": [ { @@ -35887,7 +39279,7 @@ "operationId": "repos/get-combined-status-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" }, "parameters": [ { @@ -35945,7 +39337,7 @@ "operationId": "repos/list-commit-statuses-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/statuses#list-commit-statuses-for-a-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#list-commit-statuses-for-a-reference" }, "parameters": [ { @@ -36004,14 +39396,14 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.14/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/compare-commits-with-basehead", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/commits#compare-two-commits" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/commits#compare-two-commits" }, "parameters": [ { @@ -36075,14 +39467,14 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", "tags": [ "repos" ], "operationId": "repos/get-content", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/contents#get-repository-content" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-repository-content" }, "parameters": [ { @@ -36143,7 +39535,16 @@ { "$ref": "#/components/schemas/content-submodule" } - ] + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "array": "#/components/schemas/content-directory", + "file": "#/components/schemas/content-file", + "symlink": "#/components/schemas/content-symlink", + "submodule": "#/components/schemas/content-submodule" + } + } }, "examples": { "response-if-content-is-a-file": { @@ -36165,6 +39566,9 @@ "302": { "$ref": "#/components/responses/found" }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -36182,14 +39586,14 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.14/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], "operationId": "repos/create-or-update-file-contents", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/contents#create-or-update-file-contents" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/contents#create-or-update-file-contents" }, "parameters": [ { @@ -36345,7 +39749,21 @@ "$ref": "#/components/responses/not_found" }, "409": { - "$ref": "#/components/responses/conflict" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/basic-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } }, "422": { "$ref": "#/components/responses/validation_failed" @@ -36361,14 +39779,14 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.14/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], "operationId": "repos/delete-file", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/contents#delete-a-file" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/contents#delete-a-file" }, "parameters": [ { @@ -36504,7 +39922,7 @@ "operationId": "repos/list-contributors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-contributors" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-contributors" }, "parameters": [ { @@ -36582,7 +40000,7 @@ "operationId": "dependabot/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" }, "parameters": [ { @@ -36617,7 +40035,7 @@ }, { "name": "page", - "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", "deprecated": true, "in": "query", "schema": { @@ -36627,7 +40045,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "deprecated": true, "in": "query", "schema": { @@ -36703,7 +40121,7 @@ "operationId": "dependabot/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts#get-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#get-a-dependabot-alert" }, "parameters": [ { @@ -36753,14 +40171,14 @@ }, "patch": { "summary": "Update a Dependabot alert", - "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "dependabot" ], "operationId": "dependabot/update-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts#update-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts#update-a-dependabot-alert" }, "parameters": [ { @@ -36874,7 +40292,7 @@ "operationId": "dependabot/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#list-repository-secrets" }, "parameters": [ { @@ -36946,7 +40364,7 @@ "operationId": "dependabot/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -36992,7 +40410,7 @@ "operationId": "dependabot/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-secret" }, "parameters": [ { @@ -37032,14 +40450,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -37061,7 +40479,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -37118,7 +40536,7 @@ "operationId": "dependabot/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -37155,7 +40573,7 @@ "operationId": "dependency-graph/diff-range", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" }, "parameters": [ { @@ -37223,7 +40641,7 @@ "operationId": "dependency-graph/export-sbom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -37279,7 +40697,7 @@ "operationId": "dependency-graph/create-repository-snapshot", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" }, "parameters": [ { @@ -37364,7 +40782,7 @@ "operationId": "repos/list-deployments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#list-deployments" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments" }, "parameters": [ { @@ -37456,14 +40874,14 @@ }, "post": { "summary": "Create a deployment", - "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@3.14/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#create-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#create-a-deployment" }, "parameters": [ { @@ -37496,7 +40914,7 @@ }, "required_contexts": { "type": "array", - "description": "The [status](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "description": "The [status](https://docs.github.com/enterprise-server@3.14/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "items": { "type": "string" } @@ -37629,7 +41047,7 @@ "operationId": "repos/get-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#get-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#get-a-deployment" }, "parameters": [ { @@ -37672,14 +41090,14 @@ }, "delete": { "summary": "Delete a deployment", - "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#delete-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#delete-a-deployment" }, "parameters": [ { @@ -37722,7 +41140,7 @@ "operationId": "repos/list-deployment-statuses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#list-deployment-statuses" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses" }, "parameters": [ { @@ -37786,7 +41204,7 @@ "operationId": "repos/create-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#create-a-deployment-status" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status" }, "parameters": [ { @@ -37821,7 +41239,7 @@ }, "target_url": { "type": "string", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.", "default": "" }, "log_url": { @@ -37912,7 +41330,7 @@ "operationId": "repos/get-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#get-a-deployment-status" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#get-a-deployment-status" }, "parameters": [ { @@ -37965,14 +41383,14 @@ "/repos/{owner}/{repo}/dispatches": { "post": { "summary": "Create a repository dispatch event", - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-dispatch-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-dispatch-event" }, "parameters": [ { @@ -38000,7 +41418,7 @@ }, "client_payload": { "type": "object", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.", "additionalProperties": true, "maxProperties": 10 } @@ -38050,7 +41468,7 @@ "operationId": "repos/get-all-environments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/environments#list-environments" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#list-environments" }, "parameters": [ { @@ -38108,14 +41526,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}": { "get": { "summary": "Get an environment", - "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/environments#get-an-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#get-an-environment" }, "parameters": [ { @@ -38155,14 +41573,14 @@ }, "put": { "summary": "Create or update an environment", - "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/environments#create-or-update-an-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#create-or-update-an-environment" }, "parameters": [ { @@ -38186,6 +41604,9 @@ "wait_timer": { "$ref": "#/components/schemas/wait-timer" }, + "prevent_self_review": { + "$ref": "#/components/schemas/prevent-self-review" + }, "reviewers": { "type": "array", "nullable": true, @@ -38214,6 +41635,7 @@ "default": { "value": { "wait_timer": 30, + "prevent_self_review": false, "reviewers": [ { "type": "User", @@ -38278,7 +41700,7 @@ "operationId": "repos/delete-an-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/environments#delete-an-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/environments#delete-an-environment" }, "parameters": [ { @@ -38315,7 +41737,7 @@ "operationId": "repos/list-deployment-branch-policies", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/branch-policies#list-deployment-branch-policies" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#list-deployment-branch-policies" }, "parameters": [ { @@ -38378,14 +41800,14 @@ }, "post": { "summary": "Create a deployment branch policy", - "description": "Creates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/branch-policies#create-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#create-a-deployment-branch-policy" }, "parameters": [ { @@ -38415,7 +41837,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" } } } @@ -38436,6 +41866,9 @@ }, "example-single-branch": { "$ref": "#/components/examples/deployment-branch-policy-single-branch" + }, + "example-single-tag": { + "$ref": "#/components/examples/deployment-branch-policy-single-tag" } } } @@ -38460,14 +41893,14 @@ "/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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/branch-policies#get-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#get-a-deployment-branch-policy" }, "parameters": [ { @@ -38510,14 +41943,14 @@ }, "put": { "summary": "Update a deployment branch policy", - "description": "Updates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/update-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/branch-policies#update-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#update-a-deployment-branch-policy" }, "parameters": [ { @@ -38577,14 +42010,14 @@ }, "delete": { "summary": "Delete a deployment branch policy", - "description": "Deletes a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/branch-policies#delete-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/branch-policies#delete-a-deployment-branch-policy" }, "parameters": [ { @@ -38617,14 +42050,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { "get": { "summary": "Get all deployment protection rules for an environment", - "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-all-deployment-protection-rules", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" }, "parameters": [ { @@ -38706,14 +42139,14 @@ }, "post": { "summary": "Create a custom deployment protection rule on an environment", - "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" }, "parameters": [ { @@ -38778,14 +42211,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { "get": { "summary": "List custom deployment rule integrations available for an environment", - "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/list-custom-deployment-rule-integrations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" }, "parameters": [ { @@ -38846,14 +42279,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { "get": { "summary": "Get a custom deployment protection rule", - "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-custom-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" }, "parameters": [ { @@ -38903,7 +42336,7 @@ "operationId": "repos/disable-deployment-protection-rule", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" }, "parameters": [ { @@ -38943,7 +42376,7 @@ "operationId": "actions/list-environment-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#list-environment-secrets" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#list-environment-secrets" }, "parameters": [ { @@ -39018,7 +42451,7 @@ "operationId": "actions/get-environment-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-public-key" }, "parameters": [ { @@ -39067,7 +42500,7 @@ "operationId": "actions/get-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-secret" }, "parameters": [ { @@ -39110,14 +42543,14 @@ }, "put": { "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-environment-secret" }, "parameters": [ { @@ -39142,7 +42575,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -39203,7 +42636,7 @@ "operationId": "actions/delete-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#delete-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#delete-an-environment-secret" }, "parameters": [ { @@ -39243,7 +42676,7 @@ "operationId": "actions/list-environment-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#list-environment-variables" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#list-environment-variables" }, "parameters": [ { @@ -39316,7 +42749,7 @@ "operationId": "actions/create-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#create-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#create-an-environment-variable" }, "parameters": [ { @@ -39397,7 +42830,7 @@ "operationId": "actions/get-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#get-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#get-an-environment-variable" }, "parameters": [ { @@ -39447,7 +42880,7 @@ "operationId": "actions/update-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#update-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#update-an-environment-variable" }, "parameters": [ { @@ -39513,7 +42946,7 @@ "operationId": "actions/delete-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/actions/variables#delete-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.14/rest/actions/variables#delete-an-environment-variable" }, "parameters": [ { @@ -39546,14 +42979,14 @@ "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", - "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-repo-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-repository-events" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-repository-events" }, "parameters": [ { @@ -39608,7 +43041,7 @@ "operationId": "repos/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/forks#list-forks" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/forks#list-forks" }, "parameters": [ { @@ -39678,14 +43111,14 @@ }, "post": { "summary": "Create a fork", - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", + "description": "Create a fork for the authenticated user.\n\n> [!NOTE]\n> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", "tags": [ "repos" ], "operationId": "repos/create-fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/forks#create-a-fork" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/forks#create-a-fork" }, "parameters": [ { @@ -39777,7 +43210,7 @@ "operationId": "git/create-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/blobs#create-a-blob" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/blobs#create-a-blob" }, "parameters": [ { @@ -39853,7 +43286,21 @@ "$ref": "#/components/responses/conflict" }, "422": { - "$ref": "#/components/responses/validation_failed" + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } } }, "x-github": { @@ -39868,14 +43315,14 @@ "/repos/{owner}/{repo}/git/blobs/{file_sha}": { "get": { "summary": "Get a blob", - "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", "tags": [ "git" ], "operationId": "git/get-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/blobs#get-a-blob" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/blobs#get-a-blob" }, "parameters": [ { @@ -39934,14 +43381,14 @@ "/repos/{owner}/{repo}/git/commits": { "post": { "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/commits#create-a-commit" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit" }, "parameters": [ { @@ -39968,7 +43415,7 @@ }, "parents": { "type": "array", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", "items": { "type": "string" } @@ -40091,14 +43538,14 @@ "/repos/{owner}/{repo}/git/commits/{commit_sha}": { "get": { "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/commits#get-a-commit-object" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/commits#get-a-commit-object" }, "parameters": [ { @@ -40146,14 +43593,14 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], "operationId": "git/list-matching-refs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/refs#list-matching-references" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/refs#list-matching-references" }, "parameters": [ { @@ -40206,14 +43653,14 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], "operationId": "git/get-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/refs#get-a-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference" }, "parameters": [ { @@ -40268,7 +43715,7 @@ "operationId": "git/create-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference" }, "parameters": [ { @@ -40360,7 +43807,7 @@ "operationId": "git/update-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/refs#update-a-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference" }, "parameters": [ { @@ -40445,7 +43892,7 @@ "operationId": "git/delete-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/refs#delete-a-reference" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/refs#delete-a-reference" }, "parameters": [ { @@ -40481,14 +43928,14 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/tags#create-a-tag-object" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/tags#create-a-tag-object" }, "parameters": [ { @@ -40618,14 +44065,14 @@ "/repos/{owner}/{repo}/git/tags/{tag_sha}": { "get": { "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/get-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/tags#get-a-tag" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/tags#get-a-tag" }, "parameters": [ { @@ -40678,14 +44125,14 @@ "/repos/{owner}/{repo}/git/trees": { "post": { "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.10/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.10/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", "tags": [ "git" ], "operationId": "git/create-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/trees#create-a-tree" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/trees#create-a-tree" }, "parameters": [ { @@ -40746,7 +44193,7 @@ }, "base_tree": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n" + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." } }, "required": [ @@ -40820,14 +44267,14 @@ "/repos/{owner}/{repo}/git/trees/{tree_sha}": { "get": { "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", "tags": [ "git" ], "operationId": "git/get-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree" + "url": "https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree" }, "parameters": [ { @@ -40904,7 +44351,7 @@ "operationId": "repos/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#list-repository-webhooks" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-repository-webhooks" }, "parameters": [ { @@ -40965,7 +44412,7 @@ "operationId": "repos/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#create-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#create-a-repository-webhook" }, "parameters": [ { @@ -41007,7 +44454,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -41096,7 +44543,7 @@ "operationId": "repos/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#get-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-repository-webhook" }, "parameters": [ { @@ -41146,7 +44593,7 @@ "operationId": "repos/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#update-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-repository-webhook" }, "parameters": [ { @@ -41171,7 +44618,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -41246,14 +44693,14 @@ }, "delete": { "summary": "Delete a repository webhook", - "description": "", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", "tags": [ "repos" ], "operationId": "repos/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#delete-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#delete-a-repository-webhook" }, "parameters": [ { @@ -41293,7 +44740,7 @@ "operationId": "repos/get-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -41340,7 +44787,7 @@ "operationId": "repos/update-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -41423,7 +44870,7 @@ "operationId": "repos/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" }, "parameters": [ { @@ -41440,14 +44887,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -41495,7 +44934,7 @@ "operationId": "repos/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -41553,7 +44992,7 @@ "operationId": "repos/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -41592,14 +45031,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { "post": { "summary": "Ping a repository webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) to be sent to the hook.", "tags": [ "repos" ], "operationId": "repos/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#ping-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#ping-a-repository-webhook" }, "parameters": [ { @@ -41632,14 +45071,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { "post": { "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", "tags": [ "repos" ], "operationId": "repos/test-push-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#test-the-push-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/webhooks#test-the-push-repository-webhook" }, "parameters": [ { @@ -41672,14 +45111,14 @@ "/repos/{owner}/{repo}/installation": { "get": { "summary": "Get a repository installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-repo-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" }, "parameters": [ { @@ -41731,7 +45170,7 @@ "operationId": "repos/list-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/invitations#list-repository-invitations" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#list-repository-invitations" }, "parameters": [ { @@ -41791,7 +45230,7 @@ "operationId": "repos/update-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/invitations#update-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#update-a-repository-invitation" }, "parameters": [ { @@ -41869,7 +45308,7 @@ "operationId": "repos/delete-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/invitations#delete-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#delete-a-repository-invitation" }, "parameters": [ { @@ -41899,14 +45338,14 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#list-repository-issues" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-repository-issues" }, "parameters": [ { @@ -42041,14 +45480,14 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.10/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.14/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#create-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#create-an-issue" }, "parameters": [ { @@ -42082,7 +45521,7 @@ }, "assignee": { "type": "string", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_", "nullable": true }, "milestone": { @@ -42213,14 +45652,14 @@ "/repos/{owner}/{repo}/issues/comments": { "get": { "summary": "List issue comments for a repository", - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/comments#list-issue-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments-for-a-repository" }, "parameters": [ { @@ -42298,14 +45737,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}": { "get": { "summary": "Get an issue comment", - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment" }, "parameters": [ { @@ -42348,14 +45787,14 @@ }, "patch": { "summary": "Update an issue comment", - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/comments#update-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/comments#update-an-issue-comment" }, "parameters": [ { @@ -42431,7 +45870,7 @@ "operationId": "issues/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/comments#delete-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/comments#delete-an-issue-comment" }, "parameters": [ { @@ -42461,14 +45900,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for an issue comment", - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment).", + "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue-comment" }, "parameters": [ { @@ -42482,7 +45921,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", "in": "query", "required": false, "schema": { @@ -42544,14 +45983,14 @@ }, "post": { "summary": "Create reaction for an issue comment", - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue-comment" }, "parameters": [ { @@ -42573,7 +46012,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the issue comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the issue comment.", "enum": [ "+1", "-1", @@ -42647,14 +46086,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#delete-an-issue-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-comment-reaction" }, "parameters": [ { @@ -42694,7 +46133,7 @@ "operationId": "issues/list-events-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/events#list-issue-events-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events-for-a-repository" }, "parameters": [ { @@ -42757,7 +46196,7 @@ "operationId": "issues/get-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/events#get-an-issue-event" }, "parameters": [ { @@ -42813,14 +46252,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.10/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.14/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue" }, "parameters": [ { @@ -42872,14 +46311,14 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -42919,7 +46358,7 @@ "assignee": { "type": "string", "nullable": true, - "description": "Username to assign to this issue. **This field is deprecated.**" + "description": "Username to assign to this issue. **This field is closing down.**" }, "state": { "type": "string", @@ -43064,7 +46503,7 @@ "operationId": "issues/add-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#add-assignees-to-an-issue" }, "parameters": [ { @@ -43221,7 +46660,7 @@ "operationId": "issues/check-user-can-be-assigned-to-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" }, "parameters": [ { @@ -43269,14 +46708,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/comments": { "get": { "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/comments#list-issue-comments" }, "parameters": [ { @@ -43339,14 +46778,14 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/comments#create-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -43442,7 +46881,7 @@ "operationId": "issues/list-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/events#list-issue-events" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/events#list-issue-events" }, "parameters": [ { @@ -43508,7 +46947,7 @@ "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#list-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -43578,7 +47017,7 @@ "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -43603,7 +47042,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.10/rest/issues/labels#set-labels-for-an-issue).\"", + "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-an-issue).\"", "items": { "type": "string" } @@ -43694,7 +47133,7 @@ "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -43719,7 +47158,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.10/rest/issues/labels#add-labels-to-an-issue).\"", + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.14/rest/issues/labels#add-labels-to-an-issue).\"", "items": { "type": "string" } @@ -43810,7 +47249,7 @@ "operationId": "issues/remove-all-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-all-labels-from-an-issue" }, "parameters": [ { @@ -43856,7 +47295,7 @@ "operationId": "issues/remove-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#remove-a-label-from-an-issue" }, "parameters": [ { @@ -43918,14 +47357,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/lock": { "put": { "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "issues" ], "operationId": "issues/lock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#lock-an-issue" }, "parameters": [ { @@ -44003,7 +47442,7 @@ "operationId": "issues/unlock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#unlock-an-issue" }, "parameters": [ { @@ -44039,14 +47478,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { "get": { "summary": "List reactions for an issue", - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue).", + "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-an-issue" }, "parameters": [ { @@ -44060,7 +47499,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", "in": "query", "required": false, "schema": { @@ -44125,14 +47564,14 @@ }, "post": { "summary": "Create reaction for an issue", - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", + "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-an-issue" }, "parameters": [ { @@ -44154,7 +47593,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the issue.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the issue.", "enum": [ "+1", "-1", @@ -44228,14 +47667,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#delete-an-issue-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-an-issue-reaction" }, "parameters": [ { @@ -44275,7 +47714,7 @@ "operationId": "issues/list-events-for-timeline", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/timeline#list-timeline-events-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/timeline#list-timeline-events-for-an-issue" }, "parameters": [ { @@ -44344,7 +47783,7 @@ "operationId": "repos/list-deploy-keys", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#list-deploy-keys" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#list-deploy-keys" }, "parameters": [ { @@ -44402,7 +47841,7 @@ "operationId": "repos/create-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#create-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#create-a-deploy-key" }, "parameters": [ { @@ -44429,7 +47868,7 @@ }, "read_only": { "type": "boolean", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.10/articles/permission-levels-for-a-user-account-repository/).\"" + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.14/articles/permission-levels-for-a-user-account-repository/).\"" } }, "required": [ @@ -44495,7 +47934,7 @@ "operationId": "repos/get-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#get-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key" }, "parameters": [ { @@ -44545,7 +47984,7 @@ "operationId": "repos/delete-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#delete-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#delete-a-deploy-key" }, "parameters": [ { @@ -44582,7 +48021,7 @@ "operationId": "issues/list-labels-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#list-labels-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-a-repository" }, "parameters": [ { @@ -44643,7 +48082,7 @@ "operationId": "issues/create-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#create-a-label" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#create-a-label" }, "parameters": [ { @@ -44739,7 +48178,7 @@ "operationId": "issues/get-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#get-a-label" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#get-a-label" }, "parameters": [ { @@ -44794,7 +48233,7 @@ "operationId": "issues/update-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#update-a-label" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#update-a-label" }, "parameters": [ { @@ -44879,7 +48318,7 @@ "operationId": "issues/delete-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#delete-a-label" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#delete-a-label" }, "parameters": [ { @@ -44921,7 +48360,7 @@ "operationId": "repos/list-languages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-languages" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-languages" }, "parameters": [ { @@ -44967,7 +48406,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/lfs#enable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#enable-git-lfs-for-a-repository" }, "parameters": [ { @@ -45002,7 +48441,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/lfs#disable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#disable-git-lfs-for-a-repository" }, "parameters": [ { @@ -45029,14 +48468,14 @@ "/repos/{owner}/{repo}/license": { "get": { "summary": "Get the license for a repository", - "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "licenses" ], "operationId": "licenses/get-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/licenses/licenses#get-the-license-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/licenses/licenses#get-the-license-for-a-repository" }, "parameters": [ { @@ -45044,6 +48483,9 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref" } ], "responses": { @@ -45085,7 +48527,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -45163,7 +48605,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/branches/branches#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.14/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -45261,7 +48703,7 @@ "operationId": "issues/list-milestones", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/milestones#list-milestones" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#list-milestones" }, "parameters": [ { @@ -45365,7 +48807,7 @@ "operationId": "issues/create-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/milestones#create-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#create-a-milestone" }, "parameters": [ { @@ -45472,7 +48914,7 @@ "operationId": "issues/get-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/milestones#get-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#get-a-milestone" }, "parameters": [ { @@ -45522,7 +48964,7 @@ "operationId": "issues/update-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/milestones#update-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#update-a-milestone" }, "parameters": [ { @@ -45613,7 +49055,7 @@ "operationId": "issues/delete-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/milestones#delete-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/milestones#delete-a-milestone" }, "parameters": [ { @@ -45653,7 +49095,7 @@ "operationId": "issues/list-labels-for-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/labels#list-labels-for-issues-in-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/labels#list-labels-for-issues-in-a-milestone" }, "parameters": [ { @@ -45716,7 +49158,7 @@ "operationId": "activity/list-repo-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -45779,14 +49221,14 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-repo-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#mark-repository-notifications-as-read" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#mark-repository-notifications-as-read" }, "parameters": [ { @@ -45869,7 +49311,7 @@ "operationId": "repos/get-pages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#get-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-a-apiname-pages-site" }, "parameters": [ { @@ -45916,7 +49358,7 @@ "operationId": "repos/create-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#create-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-apiname-pages-site" }, "parameters": [ { @@ -46032,7 +49474,7 @@ "operationId": "repos/update-information-about-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#update-information-about-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#update-information-about-a-apiname-pages-site" }, "parameters": [ { @@ -46051,7 +49493,7 @@ "properties": { "cname": { "type": "string", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.10/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.14/pages/configuring-a-custom-domain-for-your-github-pages-site).\"", "nullable": true }, "https_enforced": { @@ -46175,7 +49617,7 @@ "operationId": "repos/delete-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#delete-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#delete-a-apiname-pages-site" }, "parameters": [ { @@ -46218,7 +49660,7 @@ "operationId": "repos/list-pages-builds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#list-apiname-pages-builds" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#list-apiname-pages-builds" }, "parameters": [ { @@ -46276,7 +49718,7 @@ "operationId": "repos/request-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#request-a-apiname-pages-build" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#request-a-apiname-pages-build" }, "parameters": [ { @@ -46322,7 +49764,7 @@ "operationId": "repos/get-latest-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#get-latest-pages-build" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-latest-pages-build" }, "parameters": [ { @@ -46368,7 +49810,7 @@ "operationId": "repos/get-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#get-apiname-pages-build" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-apiname-pages-build" }, "parameters": [ { @@ -46422,7 +49864,7 @@ "operationId": "repos/create-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pages/pages#create-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#create-a-github-pages-deployment" }, "parameters": [ { @@ -46514,17 +49956,17 @@ "x-octokit": {} } }, - "/repos/{owner}/{repo}/pre-receive-hooks": { + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { "get": { - "summary": "List pre-receive hooks for a repository", - "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.", - "operationId": "enterprise-admin/list-pre-receive-hooks-for-repo", + "summary": "Get the status of a GitHub Pages deployment", + "description": "Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.", "tags": [ - "enterprise-admin" + "repos" ], + "operationId": "repos/get-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#get-the-status-of-a-github-pages-deployment" }, "parameters": [ { @@ -46534,27 +49976,7 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/direction" - }, - { - "name": "sort", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "name" - ], - "default": "created" - } + "$ref": "#/components/parameters/pages-deployment-id" } ], "responses": { @@ -46563,40 +49985,80 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository-pre-receive-hook" - } + "$ref": "#/components/schemas/pages-deployment-status" }, "examples": { "default": { - "$ref": "#/components/examples/repository-pre-receive-hook-items" + "$ref": "#/components/examples/pages-deployment-status" } } } } + }, + "404": { + "$ref": "#/components/responses/not_found" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "repo-pre-receive-hooks" + "category": "pages", + "subcategory": "pages" }, "x-octokit": {} } }, - "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": { + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + "post": { + "summary": "Cancel a GitHub Pages deployment", + "description": "Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.", + "tags": [ + "repos" + ], + "operationId": "repos/cancel-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/pages/pages#cancel-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pages-deployment-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pre-receive-hooks": { "get": { - "summary": "Get a pre-receive hook for a repository", - "description": "", - "operationId": "enterprise-admin/get-pre-receive-hook-for-repo", + "summary": "List pre-receive hooks for a repository", + "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.", + "operationId": "enterprise-admin/list-pre-receive-hooks-for-repo", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository" }, "parameters": [ { @@ -46606,7 +50068,27 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/pre-receive-hook-id" + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -46615,11 +50097,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/repository-pre-receive-hook" + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-pre-receive-hook" + } }, "examples": { "default": { - "$ref": "#/components/examples/repository-pre-receive-hook" + "$ref": "#/components/examples/repository-pre-receive-hook-items" } } } @@ -46633,17 +50118,66 @@ "subcategory": "repo-pre-receive-hooks" }, "x-octokit": {} - }, - "patch": { - "summary": "Update pre-receive hook enforcement for a repository", - "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`", - "operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-repo", + } + }, + "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": { + "get": { + "summary": "Get a pre-receive hook for a repository", + "description": "", + "operationId": "enterprise-admin/get-pre-receive-hook-for-repo", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pre-receive-hook-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-pre-receive-hook" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-pre-receive-hook" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "repo-pre-receive-hooks" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update pre-receive hook enforcement for a repository", + "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`", + "operationId": "enterprise-admin/update-pre-receive-hook-enforcement-for-repo", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository" }, "parameters": [ { @@ -46718,7 +50252,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository" }, "parameters": [ { @@ -46767,7 +50301,7 @@ "operationId": "projects/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#list-repository-projects" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#list-repository-projects" }, "parameters": [ { @@ -46855,7 +50389,7 @@ "operationId": "projects/create-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#create-a-repository-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#create-a-repository-project" }, "parameters": [ { @@ -46937,17 +50471,140 @@ "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 read 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-server@3.14/rest/repos/custom-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": "custom-properties" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/pulls": { "get": { "summary": "List pull requests", - "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests" }, "parameters": [ { @@ -47066,14 +50723,14 @@ }, "post": { "summary": "Create a pull request", - "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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#create-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#create-a-pull-request" }, "parameters": [ { @@ -47114,11 +50771,11 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.10/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.14/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." }, "draft": { "type": "boolean", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.10/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.14/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." }, "issue": { "type": "integer", @@ -47189,14 +50846,14 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#list-review-comments-in-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-in-a-repository" }, "parameters": [ { @@ -47278,14 +50935,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -47328,14 +50985,14 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#update-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#update-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -47408,7 +51065,7 @@ "operationId": "pulls/delete-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -47441,14 +51098,14 @@ "/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/rest/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.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/list-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" }, "parameters": [ { @@ -47462,7 +51119,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", "required": false, "schema": { @@ -47524,14 +51181,14 @@ }, "post": { "summary": "Create reaction for a pull request review comment", - "description": "Create a reaction 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). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" }, "parameters": [ { @@ -47553,7 +51210,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", "enum": [ "+1", "-1", @@ -47627,14 +51284,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction 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).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-pull-request-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#delete-a-pull-request-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-pull-request-comment-reaction" }, "parameters": [ { @@ -47667,14 +51324,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get a pull request", - "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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], "operationId": "pulls/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request" }, "parameters": [ { @@ -47689,7 +51346,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -47729,14 +51386,14 @@ }, "patch": { "summary": "Update a pull request", - "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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request" }, "parameters": [ { @@ -47778,7 +51435,7 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.10/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.14/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." } } }, @@ -47830,14 +51487,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#list-review-comments-on-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#list-review-comments-on-a-pull-request" }, "parameters": [ { @@ -47910,14 +51567,14 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#create-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -47951,7 +51608,7 @@ }, "position": { "type": "integer", - "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "deprecated": true, "x-github": { "deprecationDate": "2022-11-01" @@ -47959,7 +51616,7 @@ }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.10/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.14/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -47971,11 +51628,11 @@ }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -48063,14 +51720,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-reply-for-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#create-a-reply-for-a-review-comment" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#create-a-reply-for-a-review-comment" }, "parameters": [ { @@ -48153,14 +51810,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { "get": { "summary": "List commits on a pull request", - "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-commits-on-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-commits-on-a-pull-request" }, "parameters": [ { @@ -48216,14 +51873,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests-files" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests-files" }, "parameters": [ { @@ -48295,7 +51952,7 @@ "operationId": "pulls/check-if-merged", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" }, "parameters": [ { @@ -48326,14 +51983,14 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], "operationId": "pulls/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#merge-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#merge-a-pull-request" }, "parameters": [ { @@ -48477,14 +52134,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": [ "pulls" ], "operationId": "pulls/list-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -48630,7 +52287,7 @@ "operationId": "pulls/remove-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" }, "parameters": [ { @@ -48718,14 +52375,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { "get": { "summary": "List reviews for a pull request", - "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-reviews", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#list-reviews-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-reviews-for-a-pull-request" }, "parameters": [ { @@ -48779,14 +52436,14 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#create-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#create-a-review-for-a-pull-request" }, "parameters": [ { @@ -48816,7 +52473,7 @@ }, "event": { "type": "string", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -48921,14 +52578,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { "get": { "summary": "Get a review for a pull request", - "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#get-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#get-a-review-for-a-pull-request" }, "parameters": [ { @@ -48974,14 +52631,14 @@ }, "put": { "summary": "Update a review for a pull request", - "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#update-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#update-a-review-for-a-pull-request" }, "parameters": [ { @@ -49053,14 +52710,14 @@ }, "delete": { "summary": "Delete a pending review for a pull request", - "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/delete-pending-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" }, "parameters": [ { @@ -49111,14 +52768,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { "get": { "summary": "List comments for a pull request review", - "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-comments-for-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#list-comments-for-a-pull-request-review" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-comments-for-a-pull-request-review" }, "parameters": [ { @@ -49180,14 +52837,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/dismiss-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" }, "parameters": [ { @@ -49272,14 +52929,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { "post": { "summary": "Submit a review for a pull request", - "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/submit-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request" }, "parameters": [ { @@ -49369,14 +53026,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { "put": { "summary": "Update a pull request branch", - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.", "tags": [ "pulls" ], "operationId": "pulls/update-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request-branch" + "url": "https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request-branch" }, "parameters": [ { @@ -49399,7 +53056,7 @@ "properties": { "expected_head_sha": { "type": "string", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." } } }, @@ -49459,14 +53116,14 @@ "/repos/{owner}/{repo}/readme": { "get": { "summary": "Get a repository README", - "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/contents#get-a-repository-readme" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme" }, "parameters": [ { @@ -49501,6 +53158,9 @@ } } }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "404": { "$ref": "#/components/responses/not_found" }, @@ -49520,14 +53180,14 @@ "/repos/{owner}/{repo}/readme/{dir}": { "get": { "summary": "Get a repository README for a directory", - "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme-in-directory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/contents#get-a-repository-readme-for-a-directory" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/contents#get-a-repository-readme-for-a-directory" }, "parameters": [ { @@ -49591,14 +53251,14 @@ "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", "tags": [ "repos" ], "operationId": "repos/list-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#list-releases" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#list-releases" }, "parameters": [ { @@ -49652,14 +53312,14 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], "operationId": "repos/create-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release" }, "parameters": [ { @@ -49715,7 +53375,7 @@ "false", "legacy" ], - "default": true + "default": "true" } }, "required": [ @@ -49779,14 +53439,14 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], "operationId": "repos/get-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/assets#get-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/assets#get-a-release-asset" }, "parameters": [ { @@ -49839,7 +53499,7 @@ "operationId": "repos/update-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/assets#update-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/assets#update-a-release-asset" }, "parameters": [ { @@ -49918,7 +53578,7 @@ "operationId": "repos/delete-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/assets#delete-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/assets#delete-a-release-asset" }, "parameters": [ { @@ -49948,14 +53608,14 @@ "/repos/{owner}/{repo}/releases/generate-notes": { "post": { "summary": "Generate release notes content for a release", - "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", + "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", "tags": [ "repos" ], "operationId": "repos/generate-release-notes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#generate-release-notes-content-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#generate-release-notes-content-for-a-release" }, "parameters": [ { @@ -50045,7 +53705,7 @@ "operationId": "repos/get-latest-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release" }, "parameters": [ { @@ -50091,7 +53751,7 @@ "operationId": "repos/get-release-by-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release-by-tag-name" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release-by-tag-name" }, "parameters": [ { @@ -50143,14 +53803,14 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], "operationId": "repos/get-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release" }, "parameters": [ { @@ -50165,7 +53825,7 @@ ], "responses": { "200": { - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "content": { "application/json": { "schema": { @@ -50200,7 +53860,7 @@ "operationId": "repos/update-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#update-a-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#update-a-release" }, "parameters": [ { @@ -50305,7 +53965,7 @@ "operationId": "repos/delete-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/releases#delete-a-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/releases#delete-a-release" }, "parameters": [ { @@ -50342,7 +54002,7 @@ "operationId": "repos/list-release-assets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets" }, "parameters": [ { @@ -50396,18 +54056,18 @@ }, "post": { "summary": "Upload a release asset", - "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", + "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", "tags": [ "repos" ], "operationId": "repos/upload-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/releases/assets#upload-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.14/rest/releases/assets#upload-a-release-asset" }, "servers": [ { - "url": "https://uploads.github.com", + "url": "https://HOSTNAME/api/uploads", "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], @@ -50486,14 +54146,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions": { "get": { "summary": "List reactions for a release", - "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release).", + "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/list-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-release" }, "parameters": [ { @@ -50507,7 +54167,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", "in": "query", "required": false, "schema": { @@ -50567,14 +54227,14 @@ }, "post": { "summary": "Create reaction for a release", - "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", + "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", "tags": [ "reactions" ], "operationId": "reactions/create-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-release" }, "parameters": [ { @@ -50596,7 +54256,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the release.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the release.", "enum": [ "+1", "laugh", @@ -50668,14 +54328,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#delete-a-release-reaction" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-a-release-reaction" }, "parameters": [ { @@ -50715,7 +54375,7 @@ "operationId": "repos/list-cache-info", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-cache-replication-status" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-cache-replication-status" }, "parameters": [ { @@ -50832,6 +54492,659 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/rules/branches/{branch}": { + "get": { + "summary": "Get rules for a branch", + "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.", + "tags": [ + "repos" + ], + "operationId": "repos/get-branch-rules", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-rules-for-a-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule-detailed" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-rule-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/rulesets": { + "get": { + "summary": "Get all repository rulesets", + "description": "Get all the rulesets for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rulesets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-all-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "includes_parents", + "description": "Include rulesets configured at higher levels that apply to this repository", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + }, + { + "$ref": "#/components/parameters/ruleset-targets" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a repository ruleset", + "description": "Create a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/rules#create-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "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-server@3.14/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-server@3.14/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-server@3.14/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-server@3.14/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", + "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "includes_parents", + "description": "Include rulesets configured at higher levels that apply to this repository", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "put": { + "summary": "Update a repository ruleset", + "description": "Update a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/update-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/rules#update-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a repository ruleset", + "description": "Delete a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/rules#delete-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for a repository", @@ -50842,7 +55155,7 @@ "operationId": "secret-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -50877,6 +55190,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -50924,7 +55240,7 @@ "operationId": "secret-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" }, "parameters": [ { @@ -50980,7 +55296,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" }, "parameters": [ { @@ -51073,7 +55389,7 @@ "operationId": "secret-scanning/list-locations-for-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" }, "parameters": [ { @@ -51136,14 +55452,14 @@ "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", - "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-stargazers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/starring#list-stargazers" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-stargazers" }, "parameters": [ { @@ -51219,7 +55535,7 @@ "operationId": "repos/get-code-frequency-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/metrics/statistics#get-the-weekly-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-activity" }, "parameters": [ { @@ -51274,7 +55590,7 @@ "operationId": "repos/get-commit-activity-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/metrics/statistics#get-the-last-year-of-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-last-year-of-commit-activity" }, "parameters": [ { @@ -51329,7 +55645,7 @@ "operationId": "repos/get-contributors-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/metrics/statistics#get-all-contributor-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-all-contributor-commit-activity" }, "parameters": [ { @@ -51384,7 +55700,7 @@ "operationId": "repos/get-participation-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/metrics/statistics#get-the-weekly-commit-count" + "url": "https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-weekly-commit-count" }, "parameters": [ { @@ -51433,7 +55749,7 @@ "operationId": "repos/get-punch-card-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" + "url": "https://docs.github.com/enterprise-server@3.14/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" }, "parameters": [ { @@ -51485,7 +55801,7 @@ "operationId": "repos/create-commit-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/commits/statuses#create-a-commit-status" + "url": "https://docs.github.com/enterprise-server@3.14/rest/commits/statuses#create-a-commit-status" }, "parameters": [ { @@ -51598,7 +55914,7 @@ "operationId": "activity/list-watchers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/watching#list-watchers" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/watching#list-watchers" }, "parameters": [ { @@ -51658,7 +55974,7 @@ "operationId": "activity/get-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/watching#get-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription" }, "parameters": [ { @@ -51701,14 +56017,14 @@ }, "put": { "summary": "Set a repository subscription", - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#delete-a-repository-subscription) completely.", + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription) completely.", "tags": [ "activity" ], "operationId": "activity/set-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/watching#set-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription" }, "parameters": [ { @@ -51773,14 +56089,14 @@ }, "delete": { "summary": "Delete a repository subscription", - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#set-a-repository-subscription).", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription).", "tags": [ "activity" ], "operationId": "activity/delete-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/watching#delete-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription" }, "parameters": [ { @@ -51814,7 +56130,7 @@ "operationId": "repos/list-tags", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-tags" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags" }, "parameters": [ { @@ -51866,15 +56182,15 @@ }, "/repos/{owner}/{repo}/tags/protection": { "get": { - "summary": "List tag protection states for a repository", - "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", + "summary": "Closing down - List tag protection states for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/list-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/tags#list-tag-protection-states-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository" }, "parameters": [ { @@ -51914,20 +56230,23 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} }, "post": { - "summary": "Create a tag protection state for a repository", - "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Create a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/create-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/tags#create-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -51990,22 +56309,25 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { "delete": { - "summary": "Delete a tag protection state for a repository", - "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Delete a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/delete-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/tags#delete-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -52033,21 +56355,24 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tarball/{ref}": { "get": { "summary": "Download a repository archive (tar)", - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", "tags": [ "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/contents#download-a-repository-archive-tar" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-tar" }, "operationId": "repos/download-tarball-archive", "parameters": [ @@ -52109,7 +56434,7 @@ "operationId": "repos/list-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-teams" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-teams" }, "parameters": [ { @@ -52172,7 +56497,7 @@ "operationId": "repos/get-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-all-repository-topics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-all-repository-topics" }, "parameters": [ { @@ -52225,7 +56550,7 @@ "operationId": "repos/replace-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#replace-all-repository-topics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics" }, "parameters": [ { @@ -52244,7 +56569,7 @@ "properties": { "names": { "type": "array", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.", "items": { "type": "string" } @@ -52304,14 +56629,14 @@ "/repos/{owner}/{repo}/transfer": { "post": { "summary": "Transfer a repository", - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.10/articles/about-repository-transfers/).", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.14/articles/about-repository-transfers/).", "tags": [ "repos" ], "operationId": "repos/transfer", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#transfer-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#transfer-a-repository" }, "parameters": [ { @@ -52392,14 +56717,14 @@ "/repos/{owner}/{repo}/vulnerability-alerts": { "get": { "summary": "Check if vulnerability alerts are enabled for a repository", - "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/check-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" }, "parameters": [ { @@ -52427,14 +56752,14 @@ }, "put": { "summary": "Enable vulnerability alerts", - "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/enable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#enable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#enable-vulnerability-alerts" }, "parameters": [ { @@ -52459,14 +56784,14 @@ }, "delete": { "summary": "Disable vulnerability alerts", - "description": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/disable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#disable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#disable-vulnerability-alerts" }, "parameters": [ { @@ -52493,13 +56818,13 @@ "/repos/{owner}/{repo}/zipball/{ref}": { "get": { "summary": "Download a repository archive (zip)", - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "tags": [ "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/contents#download-a-repository-archive-zip" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/contents#download-a-repository-archive-zip" }, "operationId": "repos/download-zipball-archive", "parameters": [ @@ -52554,14 +56879,14 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "tags": [ "repos" ], "operationId": "repos/create-using-template", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-using-a-template" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-using-a-template" }, "parameters": [ { @@ -52658,14 +56983,14 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "repos", "subcategory": "repos", "previews": [ { "required": true, "name": "baptiste", - "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -52675,14 +57000,14 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", "tags": [ "repos" ], "operationId": "repos/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-public-repositories" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-public-repositories" }, "parameters": [ { @@ -52750,7 +57075,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -52758,7 +57083,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" }, "parameters": [ { @@ -52833,14 +57158,14 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, "parameters": [ { @@ -52915,14 +57240,14 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" }, "parameters": [ { @@ -52980,14 +57305,14 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" }, "parameters": [ { @@ -53090,14 +57415,14 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" }, "parameters": [ { @@ -53210,14 +57535,14 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nDeletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" }, "parameters": [ { @@ -53262,14 +57587,14 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" }, "parameters": [ { @@ -53341,14 +57666,14 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, "parameters": [ { @@ -53423,14 +57748,14 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" }, "parameters": [ { @@ -53485,14 +57810,14 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" }, "parameters": [ { @@ -53565,14 +57890,14 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" }, "parameters": [ { @@ -53703,14 +58028,14 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" }, "parameters": [ { @@ -53755,19 +58080,19 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", "tags": [ "search" ], "operationId": "search/code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code" + "url": "https://docs.github.com/enterprise-server@3.14/rest/search/search#search-code" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -53776,7 +58101,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -53867,19 +58192,19 @@ "/search/commits": { "get": { "summary": "Search commits", - "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", "tags": [ "search" ], "operationId": "search/commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/search/search#search-commits" + "url": "https://docs.github.com/enterprise-server@3.14/rest/search/search#search-commits" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -53888,7 +58213,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -53960,19 +58285,19 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.14/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], "operationId": "search/issues-and-pull-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/search/search#search-issues-and-pull-requests" + "url": "https://docs.github.com/enterprise-server@3.14/rest/search/search#search-issues-and-pull-requests" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -53981,7 +58306,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -54071,14 +58396,14 @@ "/search/labels": { "get": { "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/search/search#search-labels" + "url": "https://docs.github.com/enterprise-server@3.14/rest/search/search#search-labels" }, "parameters": [ { @@ -54092,7 +58417,7 @@ }, { "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query).", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -54101,7 +58426,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -54182,19 +58507,19 @@ "/search/repositories": { "get": { "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], "operationId": "search/repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/search/search#search-repositories" + "url": "https://docs.github.com/enterprise-server@3.14/rest/search/search#search-repositories" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.10/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.14/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -54203,7 +58528,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -54283,19 +58608,19 @@ "/search/topics": { "get": { "summary": "Search topics", - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-server@3.10/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-server@3.14/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/search/search#search-topics" + "url": "https://docs.github.com/enterprise-server@3.14/rest/search/search#search-topics" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query).", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -54360,19 +58685,19 @@ "/search/users": { "get": { "summary": "Search users", - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search).\"", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-server@3.14/graphql/reference/queries#search).\"", "tags": [ "search" ], "operationId": "search/users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/search/search#search-users" + "url": "https://docs.github.com/enterprise-server@3.14/rest/search/search#search-users" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -54381,7 +58706,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -54467,7 +58792,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-the-configuration-status" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-the-configuration-status" }, "servers": [ { @@ -54523,7 +58848,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#start-a-configuration-process" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process" }, "servers": [ { @@ -54567,7 +58892,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-the-maintenance-status" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-the-maintenance-status" }, "servers": [ { @@ -54614,14 +58939,14 @@ }, "post": { "summary": "Enable or disable maintenance mode", - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "> [!NOTE]\n> The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", "operationId": "enterprise-admin/enable-or-disable-maintenance-mode", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode" }, "servers": [ { @@ -54696,14 +59021,14 @@ "/setup/api/settings": { "get": { "summary": "Get settings", - "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API.", + "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings).\n\n> [!NOTE]\n> You cannot retrieve the management console password with the Enterprise administration API.", "operationId": "enterprise-admin/get-settings", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings" }, "servers": [ { @@ -54750,14 +59075,14 @@ }, "put": { "summary": "Set settings", - "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", + "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", "operationId": "enterprise-admin/set-settings", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#set-settings" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings" }, "servers": [ { @@ -54791,7 +59116,7 @@ "properties": { "settings": { "type": "string", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings)." + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings)." } }, "required": [ @@ -54827,7 +59152,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys" }, "servers": [ { @@ -54884,7 +59209,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#add-an-authorized-ssh-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#add-an-authorized-ssh-key" }, "servers": [ { @@ -54967,7 +59292,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key" }, "servers": [ { @@ -55045,14 +59370,14 @@ "/setup/api/start": { "post": { "summary": "Create a GitHub license", - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/create-enterprise-server-license", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#create-a-github-license" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#create-a-github-license" }, "servers": [ { @@ -55094,7 +59419,7 @@ }, "settings": { "type": "string", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings)." + "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings)." } }, "required": [ @@ -55124,14 +59449,14 @@ "/setup/api/upgrade": { "post": { "summary": "Upgrade a license", - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "description": "This API upgrades your license and also triggers the configuration process.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "operationId": "enterprise-admin/upgrade-license", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#upgrade-a-license" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#upgrade-a-license" }, "servers": [ { @@ -55191,14 +59516,14 @@ "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -55238,14 +59563,14 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], "operationId": "teams/update-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#update-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -55285,7 +59610,7 @@ }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -55370,14 +59695,14 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], "operationId": "teams/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#delete-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team-legacy" }, "parameters": [ { @@ -55410,14 +59735,14 @@ "/teams/{team_id}/discussions": { "get": { "summary": "List discussions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy" }, "parameters": [ { @@ -55471,14 +59796,14 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#create-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy" }, "parameters": [ { @@ -55555,14 +59880,14 @@ "/teams/{team_id}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy" }, "parameters": [ { @@ -55602,14 +59927,14 @@ }, "patch": { "summary": "Update a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#update-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy" }, "parameters": [ { @@ -55676,14 +60001,14 @@ }, "delete": { "summary": "Delete a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#delete-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy" }, "parameters": [ { @@ -55713,14 +60038,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#list-discussion-comments-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -55777,14 +60102,14 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#create-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -55853,14 +60178,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -55903,14 +60228,14 @@ }, "patch": { "summary": "Update a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#update-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -55979,14 +60304,14 @@ }, "delete": { "summary": "Delete a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#delete-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment-legacy" }, "parameters": [ { @@ -56019,14 +60344,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" }, "parameters": [ { @@ -56040,7 +60365,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", "required": false, "schema": { @@ -56102,14 +60427,14 @@ }, "post": { "summary": "Create reaction for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" }, "parameters": [ { @@ -56131,7 +60456,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "enum": [ "+1", "-1", @@ -56190,14 +60515,14 @@ "/teams/{team_id}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" }, "parameters": [ { @@ -56208,7 +60533,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "query", "required": false, "schema": { @@ -56270,14 +60595,14 @@ }, "post": { "summary": "Create reaction for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" }, "parameters": [ { @@ -56296,7 +60621,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ "+1", "-1", @@ -56355,14 +60680,14 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.10/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], "operationId": "teams/list-members-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#list-team-members-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members-legacy" }, "parameters": [ { @@ -56433,14 +60758,14 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], "operationId": "teams/get-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-member-legacy" }, "parameters": [ { @@ -56471,14 +60796,14 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-team-member-legacy" }, "parameters": [ { @@ -56515,14 +60840,14 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-member-legacy" }, "parameters": [ { @@ -56555,14 +60880,14 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -56605,14 +60930,14 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -56690,14 +61015,14 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -56730,14 +61055,14 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "tags": [ "teams" ], "operationId": "teams/list-projects-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects-legacy" }, "parameters": [ { @@ -56793,14 +61118,14 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-project-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-project-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project-legacy" }, "parameters": [ { @@ -56843,14 +61168,14 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", "tags": [ "teams" ], "operationId": "teams/add-or-update-project-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions-legacy" }, "parameters": [ { @@ -56869,7 +61194,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "enum": [ "read", "write", @@ -56912,7 +61237,7 @@ "response-if-the-project-is-not-owned-by-the-organization": { "value": { "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions" + "documentation_url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions" } } } @@ -56939,14 +61264,14 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", "tags": [ "teams" ], "operationId": "teams/remove-project-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-project-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team-legacy" }, "parameters": [ { @@ -56982,14 +61307,14 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-repositories-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -57045,14 +61370,14 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository-legacy" }, "parameters": [ { @@ -57101,14 +61426,14 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions-legacy" }, "parameters": [ { @@ -57174,14 +61499,14 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], "operationId": "teams/remove-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team-legacy" }, "parameters": [ { @@ -57214,14 +61539,14 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-child-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-child-teams-legacy" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams-legacy" }, "parameters": [ { @@ -57290,7 +61615,7 @@ "operationId": "users/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/users#get-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/users#get-the-authenticated-user" }, "parameters": [], "responses": { @@ -57306,7 +61631,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "response-with-public-and-private-profile-information": { @@ -57346,7 +61678,7 @@ "operationId": "users/update-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/users#update-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/users#update-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -57460,7 +61792,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" }, "responses": { "200": { @@ -57501,7 +61833,7 @@ "operationId": "users/list-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/emails#list-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/emails#list-email-addresses-for-the-authenticated-user" }, "parameters": [ { @@ -57575,7 +61907,7 @@ "operationId": "users/add-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/emails#add-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/emails#add-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -57592,9 +61924,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 + "example": "username@example.com" }, + "minItems": 1, "example": [] } }, @@ -57687,7 +62019,7 @@ "operationId": "users/delete-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/emails#delete-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/emails#delete-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -57704,9 +62036,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 - } + "example": "username@example.com" + }, + "minItems": 1 } }, "example": { @@ -57784,7 +62116,7 @@ "operationId": "users/list-followers-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#list-followers-of-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#list-followers-of-the-authenticated-user" }, "parameters": [ { @@ -57847,7 +62179,7 @@ "operationId": "users/list-followed-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#list-the-people-the-authenticated-user-follows" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#list-the-people-the-authenticated-user-follows" }, "parameters": [ { @@ -57920,7 +62252,7 @@ "operationId": "users/check-person-is-followed-by-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" }, "parameters": [ { @@ -57961,14 +62293,14 @@ }, "put": { "summary": "Follow a user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/follow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#follow-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#follow-a-user" }, "parameters": [ { @@ -57990,6 +62322,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -58009,7 +62344,7 @@ "operationId": "users/unfollow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#unfollow-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#unfollow-a-user" }, "parameters": [ { @@ -58052,7 +62387,7 @@ "operationId": "users/list-gpg-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" }, "parameters": [ { @@ -58126,7 +62461,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -58221,7 +62556,7 @@ "operationId": "users/get-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -58284,7 +62619,7 @@ "operationId": "users/delete-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -58340,7 +62675,7 @@ "operationId": "apps/list-installations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" }, "parameters": [ { @@ -58415,7 +62750,7 @@ "operationId": "apps/list-installation-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" }, "parameters": [ { @@ -58489,14 +62824,14 @@ "/user/installations/{installation_id}/repositories/{repository_id}": { "put": { "summary": "Add a repository to an app installation", - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], "operationId": "apps/add-repo-to-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/installations#add-a-repository-to-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/installations#add-a-repository-to-an-app-installation" }, "parameters": [ { @@ -58540,14 +62875,14 @@ }, "delete": { "summary": "Remove a repository from an app installation", - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], "operationId": "apps/remove-repo-from-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/installations#remove-a-repository-from-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/installations#remove-a-repository-from-an-app-installation" }, "parameters": [ { @@ -58596,14 +62931,14 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -58720,7 +63055,7 @@ "operationId": "users/list-public-ssh-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" }, "parameters": [ { @@ -58794,7 +63129,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -58891,7 +63226,7 @@ "operationId": "users/get-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -58954,7 +63289,7 @@ "operationId": "users/delete-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -59007,7 +63342,7 @@ "operationId": "orgs/list-memberships-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" }, "parameters": [ { @@ -59086,7 +63421,7 @@ "operationId": "orgs/get-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -59133,7 +63468,7 @@ "operationId": "orgs/update-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -59214,7 +63549,7 @@ "operationId": "migrations/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/users#list-user-migrations" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/users#list-user-migrations" }, "parameters": [ { @@ -59275,7 +63610,7 @@ "operationId": "migrations/start-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/users#start-a-user-migration" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/users#start-a-user-migration" }, "parameters": [], "requestBody": { @@ -59417,7 +63752,7 @@ "operationId": "migrations/get-archive-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/users#download-a-user-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/users#download-a-user-migration-archive" }, "parameters": [ { @@ -59457,7 +63792,7 @@ "operationId": "migrations/list-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/migrations/users#list-repositories-for-a-user-migration" + "url": "https://docs.github.com/enterprise-server@3.14/rest/migrations/users#list-repositories-for-a-user-migration" }, "parameters": [ { @@ -59520,14 +63855,14 @@ "/user/orgs": { "get": { "summary": "List organizations for the authenticated user", - "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.", "tags": [ "orgs" ], "operationId": "orgs/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#list-organizations-for-the-authenticated-user" }, "parameters": [ { @@ -59583,14 +63918,14 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" }, "parameters": [ { @@ -59655,14 +63990,14 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -59699,14 +64034,14 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#delete-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#delete-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -59742,14 +64077,14 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#restore-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#restore-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -59794,14 +64129,14 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { @@ -59882,14 +64217,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -59929,14 +64264,14 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -59975,14 +64310,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -60028,7 +64363,7 @@ "operationId": "projects/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#create-a-user-project" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#create-a-user-project" }, "parameters": [], "requestBody": { @@ -60107,14 +64442,14 @@ "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", - "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/list-public-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" }, "parameters": [ { @@ -60190,7 +64525,7 @@ "operationId": "repos/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repositories-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repositories-for-the-authenticated-user" }, "parameters": [ { @@ -60326,7 +64661,7 @@ "operationId": "repos/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -60432,7 +64767,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -60449,7 +64784,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -60554,7 +64889,7 @@ "operationId": "repos/list-invitations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" }, "parameters": [ { @@ -60620,7 +64955,7 @@ "operationId": "repos/accept-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/invitations#accept-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#accept-a-repository-invitation" }, "parameters": [ { @@ -60671,7 +65006,7 @@ "operationId": "repos/decline-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/collaborators/invitations#decline-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.14/rest/collaborators/invitations#decline-a-repository-invitation" }, "parameters": [ { @@ -60724,7 +65059,7 @@ "operationId": "users/list-social-accounts-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" }, "parameters": [ { @@ -60788,7 +65123,7 @@ "operationId": "users/add-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -60884,7 +65219,7 @@ "operationId": "users/delete-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -60967,7 +65302,7 @@ "operationId": "users/list-ssh-signing-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" }, "parameters": [ { @@ -61032,7 +65367,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -61047,7 +65382,7 @@ "example": "Personal MacBook Air" }, "key": { - "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.10/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.14/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", "type": "string", "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " } @@ -61119,7 +65454,7 @@ "operationId": "users/get-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -61172,7 +65507,7 @@ "operationId": "users/delete-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -61208,14 +65543,14 @@ "/user/starred": { "get": { "summary": "List repositories starred by the authenticated user", - "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" }, "parameters": [ { @@ -61297,7 +65632,7 @@ "operationId": "activity/check-repo-is-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" }, "parameters": [ { @@ -61341,14 +65676,14 @@ }, "put": { "summary": "Star a repository for the authenticated user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "activity" ], "operationId": "activity/star-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/starring#star-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/starring#star-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -61392,7 +65727,7 @@ "operationId": "activity/unstar-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -61438,7 +65773,7 @@ "operationId": "activity/list-watched-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" }, "parameters": [ { @@ -61501,7 +65836,7 @@ "operationId": "teams/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-teams-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-teams-for-the-authenticated-user" }, "parameters": [ { @@ -61554,17 +65889,80 @@ "x-octokit": {} } }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.14/rest/users/emails)\".", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + }, + "x-octokit": {} + } + }, "/users": { "get": { "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", "tags": [ "users" ], "operationId": "users/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/users#list-users" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/users#list-users" }, "parameters": [ { @@ -61617,14 +66015,14 @@ "/users/{username}": { "get": { "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.10/rest/users/emails)\".", + "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.14/rest/users/emails)\".", "tags": [ "users" ], "operationId": "users/get-by-username", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/users#get-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/users#get-a-user" }, "parameters": [ { @@ -61644,7 +66042,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "default-response": { @@ -61680,7 +66085,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" }, "parameters": [ { @@ -61725,14 +66130,14 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-events-for-the-authenticated-user" }, "parameters": [ { @@ -61777,14 +66182,14 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-org-events-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-organization-events-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-organization-events-for-the-authenticated-user" }, "parameters": [ { @@ -61832,14 +66237,14 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-public-events-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-events-for-a-user" }, "parameters": [ { @@ -61891,7 +66296,7 @@ "operationId": "users/list-followers-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#list-followers-of-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#list-followers-of-a-user" }, "parameters": [ { @@ -61948,7 +66353,7 @@ "operationId": "users/list-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#list-the-people-a-user-follows" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#list-the-people-a-user-follows" }, "parameters": [ { @@ -62005,7 +66410,7 @@ "operationId": "users/check-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/followers#check-if-a-user-follows-another-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/followers#check-if-a-user-follows-another-user" }, "parameters": [ { @@ -62047,7 +66452,7 @@ "operationId": "gists/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/gists/gists#list-gists-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/gists/gists#list-gists-for-a-user" }, "parameters": [ { @@ -62110,7 +66515,7 @@ "operationId": "users/list-gpg-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/gpg-keys#list-gpg-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/gpg-keys#list-gpg-keys-for-a-user" }, "parameters": [ { @@ -62167,7 +66572,7 @@ "operationId": "users/get-context-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/users#get-contextual-information-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/users#get-contextual-information-for-a-user" }, "parameters": [ { @@ -62233,14 +66638,14 @@ "/users/{username}/installation": { "get": { "summary": "Get a user installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-user-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" }, "parameters": [ { @@ -62283,7 +66688,7 @@ "operationId": "users/list-public-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/keys#list-public-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/keys#list-public-keys-for-a-user" }, "parameters": [ { @@ -62333,14 +66738,14 @@ "/users/{username}/orgs": { "get": { "summary": "List organizations for a user", - "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.10/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.14/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", "tags": [ "orgs" ], "operationId": "orgs/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#list-organizations-for-a-user" }, "parameters": [ { @@ -62390,14 +66795,14 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#list-packages-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#list-packages-for-a-user" }, "parameters": [ { @@ -62471,14 +66876,14 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-a-package-for-a-user" }, "parameters": [ { @@ -62518,14 +66923,14 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#delete-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#delete-a-package-for-a-user" }, "parameters": [ { @@ -62564,14 +66969,14 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#restore-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#restore-a-package-for-a-user" }, "parameters": [ { @@ -62619,14 +67024,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by a user", - "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" }, "parameters": [ { @@ -62680,14 +67085,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#get-a-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#get-a-package-version-for-a-user" }, "parameters": [ { @@ -62730,14 +67135,14 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#delete-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#delete-package-version-for-a-user" }, "parameters": [ { @@ -62779,14 +67184,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/packages/packages#restore-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/packages/packages#restore-package-version-for-a-user" }, "parameters": [ { @@ -62835,7 +67240,7 @@ "operationId": "projects/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/projects/projects#list-user-projects" + "url": "https://docs.github.com/enterprise-server@3.14/rest/projects/projects#list-user-projects" }, "parameters": [ { @@ -62903,14 +67308,14 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-received-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-events-received-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-events-received-by-the-authenticated-user" }, "parameters": [ { @@ -62955,14 +67360,14 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-received-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/events#list-public-events-received-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/events#list-public-events-received-by-a-user" }, "parameters": [ { @@ -63014,7 +67419,7 @@ "operationId": "repos/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repositories-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repositories-for-a-user" }, "parameters": [ { @@ -63108,14 +67513,14 @@ "/users/{username}/site_admin": { "put": { "summary": "Promote a user to be a site administrator", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "operationId": "enterprise-admin/promote-user-to-be-site-administrator", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator" }, "parameters": [ { @@ -63144,7 +67549,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#demote-a-site-administrator" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#demote-a-site-administrator" }, "parameters": [ { @@ -63175,7 +67580,7 @@ "operationId": "users/list-social-accounts-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/social-accounts#list-social-accounts-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/social-accounts#list-social-accounts-for-a-user" }, "parameters": [ { @@ -63232,7 +67637,7 @@ "operationId": "users/list-ssh-signing-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" }, "parameters": [ { @@ -63282,14 +67687,14 @@ "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", - "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/starring#list-repositories-starred-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/starring#list-repositories-starred-by-a-user" }, "parameters": [ { @@ -63362,7 +67767,7 @@ "operationId": "activity/list-repos-watched-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/activity/watching#list-repositories-watched-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/activity/watching#list-repositories-watched-by-a-user" }, "parameters": [ { @@ -63412,14 +67817,14 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#suspend-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#suspend-a-user" }, "parameters": [ { @@ -63441,7 +67846,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } }, @@ -63465,14 +67870,14 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#unsuspend-a-user" + "url": "https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#unsuspend-a-user" }, "parameters": [ { @@ -63493,7 +67898,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } }, @@ -63526,7 +67931,7 @@ "operationId": "meta/get-zen", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.10/rest/meta/meta#get-the-zen-of-github" + "url": "https://docs.github.com/enterprise-server@3.14/rest/meta/meta#get-the-zen-of-github" }, "responses": { "200": { @@ -63632,13 +68037,13 @@ } }, "x-webhooks": { - "branch-protection-rule-created": { + "branch-protection-configuration-disabled": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.10/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection)\" 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 branch protection rule was created.", - "operationId": "branch-protection-rule/created", + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.14/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection)\" 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": "All branch protections were disabled for a repository.", + "operationId": "branch-protection-configuration/disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -63696,22 +68101,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -63719,7 +68108,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-branch-protection-rule-created" + "$ref": "#/components/schemas/webhook-branch-protection-configuration-disabled" } } } @@ -63732,7 +68121,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "branch_protection_configuration", "supported-webhook-types": [ "repository", "organization", @@ -63741,13 +68130,13 @@ } } }, - "branch-protection-rule-deleted": { + "branch-protection-configuration-enabled": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.10/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection)\" 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 branch protection rule was deleted.", - "operationId": "branch-protection-rule/deleted", + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.14/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection)\" 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": "All branch protections were enabled for a repository.", + "operationId": "branch-protection-configuration/enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { @@ -63805,22 +68194,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -63828,7 +68201,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-branch-protection-rule-deleted" + "$ref": "#/components/schemas/webhook-branch-protection-configuration-enabled" } } } @@ -63841,7 +68214,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "branch_protection_configuration", "supported-webhook-types": [ "repository", "organization", @@ -63850,13 +68223,13 @@ } } }, - "branch-protection-rule-edited": { + "branch-protection-rule-created": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.10/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection)\" 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 branch protection rule was edited.", - "operationId": "branch-protection-rule/edited", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.14/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection)\" 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 branch protection rule was created.", + "operationId": "branch-protection-rule/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -63937,7 +68310,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-branch-protection-rule-edited" + "$ref": "#/components/schemas/webhook-branch-protection-rule-created" } } } @@ -63959,12 +68332,13 @@ } } }, - "cache-sync": { + "branch-protection-rule-deleted": { "post": { - "summary": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"[About repository caching](https://docs.github.com/enterprise-server@3.10/admin/enterprise-management/caching-repositories/about-repository-caching).\"", - "operationId": "cache-sync", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.14/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection)\" 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 branch protection rule was deleted.", + "operationId": "branch-protection-rule/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#cache_sync" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -64045,7 +68419,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-cache-sync" + "$ref": "#/components/schemas/webhook-branch-protection-rule-deleted" } } } @@ -64058,7 +68432,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "cache_sync", + "subcategory": "branch_protection_rule", "supported-webhook-types": [ "repository", "organization", @@ -64067,13 +68441,13 @@ } } }, - "check-run-completed": { + "branch-protection-rule-edited": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.10/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", - "operationId": "check-run/completed", + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.14/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection)\" 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 branch protection rule was edited.", + "operationId": "branch-protection-rule/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { @@ -64154,22 +68528,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed-form-encoded" - } + "$ref": "#/components/schemas/webhook-branch-protection-rule-edited" } } } @@ -64181,9 +68540,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "branch_protection_rule", "supported-webhook-types": [ "repository", "organization", @@ -64192,13 +68550,13 @@ } } }, - "check-run-created": { + "bypass-request-secret-scanning-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.10/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", - "operationId": "check-run/created", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -64256,19 +68614,96 @@ "schema": { "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-exemption-request-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, { - "name": "X-GitHub-Enterprise-Version", + "name": "X-Github-Hook-Id", "in": "header", - "example": "3.1.9", + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-GitHub-Enterprise-Host", + "name": "X-Github-Event", "in": "header", - "example": "ghes.github.com", + "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" } @@ -64279,22 +68714,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } @@ -64305,10 +68725,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -64317,13 +68736,13 @@ } } }, - "check-run-requested-action": { + "bypass-request-secret-scanning-created": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.10/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.10/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", - "operationId": "check-run/requested-action", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -64381,22 +68800,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -64404,22 +68807,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-created" } } } @@ -64430,10 +68818,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -64442,13 +68829,13 @@ } } }, - "check-run-rerequested": { + "bypass-request-secret-scanning-response-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.10/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", - "operationId": "check-run/rerequested", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -64506,22 +68893,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -64529,22 +68900,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested-form-encoded" - } + "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } @@ -64555,10 +68911,9 @@ } }, "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -64567,13 +68922,13 @@ } } }, - "check-suite-completed": { + "bypass-request-secret-scanning-response-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { @@ -64631,22 +68986,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -64654,7 +68993,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } @@ -64665,9 +69004,9 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": [ "repository", "organization", @@ -64676,13 +69015,12 @@ } } }, - "check-suite-requested": { + "cache-sync": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.10/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", - "operationId": "check-suite/requested", + "summary": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"[About repository caching](https://docs.github.com/enterprise-server@3.14/admin/enterprise-management/caching-repositories/about-repository-caching).\"", + "operationId": "cache-sync", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#cache_sync" }, "parameters": [ { @@ -64763,7 +69101,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-cache-sync" } } } @@ -64776,7 +69114,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "cache_sync", "supported-webhook-types": [ "repository", "organization", @@ -64785,13 +69123,13 @@ } } }, - "check-suite-rerequested": { + "check-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.10/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", - "operationId": "check-suite/rerequested", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.14/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -64872,7 +69210,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } } } } @@ -64884,8 +69237,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -64894,13 +69248,13 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "check-run-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.10/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.14/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", + "operationId": "check-run/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -64981,7 +69335,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } } } } @@ -64993,8 +69362,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -65003,13 +69373,13 @@ } } }, - "code-scanning-alert-closed-by-user": { + "check-run-requested-action": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.10/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.14/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.14/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -65090,7 +69460,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } } } } @@ -65102,8 +69487,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -65112,13 +69498,13 @@ } } }, - "code-scanning-alert-created": { + "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.10/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.14/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -65199,7 +69585,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-check-run-rerequested" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested-form-encoded" + } } } } @@ -65211,8 +69612,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -65221,13 +69623,13 @@ } } }, - "code-scanning-alert-fixed": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.10/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.14/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -65308,7 +69710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-check-suite-completed" } } } @@ -65321,7 +69723,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -65330,13 +69732,13 @@ } } }, - "code-scanning-alert-reopened": { + "check-suite-requested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.10/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.14/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.14/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.14/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -65417,7 +69819,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-check-suite-requested" } } } @@ -65430,7 +69832,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -65439,13 +69841,13 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.10/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.14/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.14/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -65526,7 +69928,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-check-suite-rerequested" } } } @@ -65539,7 +69941,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -65548,13 +69950,13 @@ } } }, - "commit-comment-created": { + "code-scanning-alert-appeared-in-branch": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.10/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.14/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -65635,7 +70037,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" } } } @@ -65648,7 +70050,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit_comment", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -65657,12 +70059,13 @@ } } }, - "create": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", - "operationId": "create", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.14/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -65743,7 +70146,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" } } } @@ -65756,7 +70159,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -65765,12 +70168,13 @@ } } }, - "delete": { + "code-scanning-alert-created": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.14/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -65851,7 +70255,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" } } } @@ -65864,7 +70268,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -65873,13 +70277,13 @@ } } }, - "dependabot-alert-created": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.14/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -65960,7 +70364,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" } } } @@ -65973,7 +70377,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -65982,13 +70386,13 @@ } } }, - "dependabot-alert-dismissed": { + "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.14/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -66069,7 +70473,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" } } } @@ -66082,7 +70486,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -66091,13 +70495,13 @@ } } }, - "dependabot-alert-fixed": { + "code-scanning-alert-reopened-by-user": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.14/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -66178,7 +70582,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" } } } @@ -66191,7 +70595,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -66200,13 +70604,13 @@ } } }, - "dependabot-alert-reintroduced": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.14/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -66287,7 +70691,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-commit-comment-created" } } } @@ -66300,7 +70704,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "commit_comment", "supported-webhook-types": [ "repository", "organization", @@ -66309,13 +70713,12 @@ } } }, - "dependabot-alert-reopened": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.10/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -66396,7 +70799,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-create" } } } @@ -66409,7 +70812,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "create", "supported-webhook-types": [ "repository", "organization", @@ -66418,13 +70821,12 @@ } } }, - "deploy-key-created": { + "delete": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.10/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.10/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -66505,7 +70907,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-delete" } } } @@ -66518,7 +70920,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -66527,13 +70929,13 @@ } } }, - "deploy-key-deleted": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.10/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.10/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -66614,7 +71016,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -66627,7 +71029,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -66636,13 +71038,13 @@ } } }, - "deployment-created": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.10/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -66723,7 +71125,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -66736,7 +71138,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -66745,13 +71147,13 @@ } } }, - "deployment-protection-rule-requested": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-server@3.10/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment protection rule was requested for an environment.", - "operationId": "deployment-protection-rule/requested", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deployment_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -66832,7 +71234,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -66845,20 +71247,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_protection_rule", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-approved": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.10/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -66939,7 +71343,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -66952,20 +71356,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-rejected": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.10/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67046,7 +71452,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -67059,20 +71465,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-requested": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.10/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67153,7 +71561,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -67166,20 +71574,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "dependabot_alert", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.10/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -67260,7 +71670,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -67273,7 +71683,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -67282,13 +71692,13 @@ } } }, - "discussion-answered": { + "deploy-key-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.14/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -67369,7 +71779,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -67382,7 +71792,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -67391,13 +71801,13 @@ } } }, - "discussion-category-changed": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.14/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -67478,7 +71888,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -67491,7 +71901,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -67500,13 +71910,13 @@ } } }, - "discussion-closed": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.14/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -67528,7 +71938,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -67568,7 +71978,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.9.0", + "example": "3.1.9", "schema": { "type": "string" } @@ -67587,7 +71997,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -67600,7 +72010,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -67609,13 +72019,13 @@ } } }, - "discussion-comment-created": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-server@3.14/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -67696,7 +72106,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -67709,22 +72119,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-deleted": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.14/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -67805,7 +72213,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -67818,22 +72226,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-comment-edited": { + "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.14/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -67914,7 +72320,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -67927,22 +72333,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-created": { + "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.14/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -68023,7 +72427,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -68036,22 +72440,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-deleted": { + "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.14/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#deployment_status" }, "parameters": [ { @@ -68132,7 +72534,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-deployment-status-created" } } } @@ -68145,7 +72547,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "deployment_status", "supported-webhook-types": [ "repository", "organization", @@ -68154,13 +72556,13 @@ } } }, - "discussion-edited": { + "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -68241,7 +72643,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -68263,13 +72665,13 @@ } } }, - "discussion-labeled": { + "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -68350,7 +72752,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -68372,13 +72774,13 @@ } } }, - "discussion-locked": { + "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -68400,7 +72802,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -68440,7 +72842,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.1.9", + "example": "3.9.0", "schema": { "type": "string" } @@ -68459,7 +72861,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-closed" } } } @@ -68481,13 +72883,13 @@ } } }, - "discussion-pinned": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -68568,7 +72970,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-comment-created" } } } @@ -68581,7 +72983,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -68590,13 +72992,13 @@ } } }, - "discussion-reopened": { + "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -68618,7 +73020,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -68658,7 +73060,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.9.0", + "example": "3.1.9", "schema": { "type": "string" } @@ -68677,7 +73079,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" } } } @@ -68690,7 +73092,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -68699,13 +73101,13 @@ } } }, - "discussion-transferred": { + "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -68786,7 +73188,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" } } } @@ -68799,7 +73201,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -68808,13 +73210,13 @@ } } }, - "discussion-unanswered": { + "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -68895,7 +73297,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -68917,13 +73319,13 @@ } } }, - "discussion-unlabeled": { + "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69004,7 +73406,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -69026,13 +73428,13 @@ } } }, - "discussion-unlocked": { + "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69113,7 +73515,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -69135,13 +73537,13 @@ } } }, - "discussion-unpinned": { + "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.10/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69222,7 +73624,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -69244,13 +73646,13 @@ } } }, - "enterprise-anonymous-access-disabled": { + "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", - "description": "Anonymous Git read access was disabled.", - "operationId": "enterprise/anonymous-access-disabled", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69331,7 +73733,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-disabled" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -69344,20 +73746,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "enterprise", + "subcategory": "discussion", "supported-webhook-types": [ - "business" + "repository", + "organization", + "app" ] } } }, - "enterprise-anonymous-access-enabled": { + "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", - "description": "Anonymous Git read access was enabled.", - "operationId": "enterprise/anonymous-access-enabled", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#enterprise" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69438,7 +73842,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-enabled" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -69451,19 +73855,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "enterprise", + "subcategory": "discussion", "supported-webhook-types": [ - "business" + "repository", + "organization", + "app" ] } } }, - "fork": { + "discussion-reopened": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-server@3.10/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-server@3.10/rest/repos/forks)\" 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.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69485,7 +73892,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -69525,7 +73932,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.1.9", + "example": "3.9.0", "schema": { "type": "string" } @@ -69544,7 +73951,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -69557,9 +73964,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "discussion", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -69567,13 +73973,13 @@ } } }, - "github-app-authorization-revoked": { + "discussion-transferred": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69654,7 +74060,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -69667,19 +74073,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github_app_authorization", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "gollum": { + "discussion-unanswered": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-server@3.10/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69760,7 +74169,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -69773,7 +74182,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -69782,13 +74191,13 @@ } } }, - "installation-created": { + "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69869,7 +74278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -69882,20 +74291,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-deleted": { + "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -69976,7 +74387,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -69989,20 +74400,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-new-permissions-accepted": { + "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.14/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -70083,7 +74496,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -70096,20 +74509,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-added": { + "enterprise-anonymous-access-disabled": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", + "description": "Anonymous Git read access was disabled.", + "operationId": "enterprise/anonymous-access-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#enterprise" }, "parameters": [ { @@ -70190,7 +74605,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-disabled" } } } @@ -70203,20 +74618,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "enterprise", "supported-webhook-types": [ - "app" + "business" ] } } }, - "installation-repositories-removed": { + "enterprise-anonymous-access-enabled": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", + "description": "Anonymous Git read access was enabled.", + "operationId": "enterprise/anonymous-access-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#enterprise" }, "parameters": [ { @@ -70297,7 +74712,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-enabled" } } } @@ -70310,20 +74725,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "enterprise", "supported-webhook-types": [ - "app" + "business" ] } } }, - "installation-suspend": { + "fork": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-server@3.14/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-server@3.14/rest/repos/forks)\" 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.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -70404,7 +74818,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -70417,20 +74831,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "fork", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "installation-target-renamed": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.14/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -70511,7 +74928,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -70524,20 +74941,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "github_app_authorization", "supported-webhook-types": [ "app" ] } } }, - "installation-unsuspend": { + "gollum": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.10/rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-server@3.14/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -70618,7 +75034,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -70631,20 +75047,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "gollum", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "issue-comment-created": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.10/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.10/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -70725,7 +75143,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -70738,22 +75156,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-deleted": { + "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.10/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.10/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -70834,7 +75250,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -70847,22 +75263,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issue-comment-edited": { + "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.10/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.10/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -70943,7 +75357,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -70956,22 +75370,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-assigned": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -71052,7 +75464,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -71065,22 +75477,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation_repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-closed": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -71161,7 +75571,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -71174,22 +75584,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation_repositories", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-deleted": { + "installation-suspend": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -71270,7 +75678,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -71283,22 +75691,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-demilestoned": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -71379,7 +75785,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -71392,22 +75798,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation_target", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "issues-edited": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.14/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.14/rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -71488,7 +75892,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -71501,7 +75905,114 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "installation", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "issue-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.14/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.14/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issue_comment" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -71510,13 +76021,13 @@ } } }, - "issues-labeled": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.14/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.14/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -71597,7 +76108,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -71610,7 +76121,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -71619,13 +76130,13 @@ } } }, - "issues-locked": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.10/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.14/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.14/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -71706,7 +76217,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -71719,7 +76230,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "issue_comment", "supported-webhook-types": [ "repository", "organization", @@ -71728,13 +76239,13 @@ } } }, - "issues-milestoned": { + "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -71815,7 +76326,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -71837,13 +76348,13 @@ } } }, - "issues-opened": { + "issues-closed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -71924,7 +76435,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -71946,13 +76457,13 @@ } } }, - "issues-pinned": { + "issues-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72033,7 +76544,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -72055,13 +76566,13 @@ } } }, - "issues-reopened": { + "issues-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72142,7 +76653,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -72164,13 +76675,13 @@ } } }, - "issues-transferred": { + "issues-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72251,7 +76762,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -72273,13 +76784,13 @@ } } }, - "issues-unassigned": { + "issues-labeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72360,7 +76871,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -72382,13 +76893,13 @@ } } }, - "issues-unlabeled": { + "issues-locked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72469,7 +76980,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -72491,13 +77002,13 @@ } } }, - "issues-unlocked": { + "issues-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.10/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72578,7 +77089,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -72600,13 +77111,13 @@ } } }, - "issues-unpinned": { + "issues-opened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.10/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.10/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72687,7 +77198,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -72709,13 +77220,13 @@ } } }, - "label-created": { + "issues-pinned": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.10/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72796,7 +77307,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -72809,7 +77320,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -72818,13 +77329,13 @@ } } }, - "label-deleted": { + "issues-reopened": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.10/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -72905,7 +77416,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -72918,7 +77429,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -72927,13 +77438,13 @@ } } }, - "label-edited": { + "issues-transferred": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.10/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73014,7 +77525,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -73027,7 +77538,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -73036,13 +77547,13 @@ } } }, - "member-added": { + "issues-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73123,7 +77634,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -73136,9 +77647,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "issues", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -73146,13 +77656,13 @@ } } }, - "member-edited": { + "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73233,7 +77743,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -73246,9 +77756,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "issues", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -73256,13 +77765,13 @@ } } }, - "member-removed": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.10/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73343,7 +77852,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -73356,9 +77865,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "issues", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -73366,122 +77874,13 @@ } } }, - "membership-added": { - "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.10/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.10/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", - "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#membership" - }, - "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" - } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-membership-added" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "membership", - "supported-webhook-types": [ - "organization", - "business", - "app" - ] - } - } - }, - "membership-removed": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.10/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.10/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.14/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.14/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -73562,7 +77961,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -73575,22 +77974,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "issues", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "meta-deleted": { + "label-created": { "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.14/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#meta" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -73671,7 +78070,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-label-created" } } } @@ -73684,10 +78083,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "meta", + "subcategory": "label", "supported-webhook-types": [ - "marketplace", - "business", "repository", "organization", "app" @@ -73695,13 +78092,13 @@ } } }, - "milestone-closed": { + "label-deleted": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.10/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.14/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -73782,7 +78179,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-label-deleted" } } } @@ -73795,7 +78192,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -73804,13 +78201,13 @@ } } }, - "milestone-created": { + "label-edited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.10/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.14/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -73891,7 +78288,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -73904,7 +78301,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -73913,13 +78310,13 @@ } } }, - "milestone-deleted": { + "member-added": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.10/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -74000,7 +78397,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -74013,8 +78410,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -74022,13 +78420,13 @@ } } }, - "milestone-edited": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.10/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -74109,7 +78507,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -74122,8 +78520,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -74131,13 +78530,13 @@ } } }, - "milestone-opened": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.10/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.14/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -74218,7 +78617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -74231,8 +78630,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -74240,13 +78640,13 @@ } } }, - "organization-deleted": { + "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.10/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.10/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.14/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.14/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -74327,7 +78727,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -74340,7 +78740,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "membership", "supported-webhook-types": [ "organization", "business", @@ -74349,13 +78749,13 @@ } } }, - "organization-member-added": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.10/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.10/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.14/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.14/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -74436,7 +78836,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -74449,7 +78849,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "membership", "supported-webhook-types": [ "organization", "business", @@ -74458,13 +78858,13 @@ } } }, - "organization-member-invited": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.10/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.10/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -74545,7 +78945,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -74558,22 +78958,24 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "meta", "supported-webhook-types": [ - "organization", + "marketplace", "business", + "repository", + "organization", "app" ] } } }, - "organization-member-removed": { + "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.10/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.10/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.14/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -74654,7 +79056,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -74667,22 +79069,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-renamed": { + "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.10/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.10/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.14/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -74763,7 +79165,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -74776,22 +79178,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "milestone", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "package-published": { + "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.10/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.14/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -74872,7 +79274,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -74885,7 +79287,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -74894,13 +79296,13 @@ } } }, - "package-updated": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.10/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.14/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -74981,7 +79383,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -74994,7 +79396,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -75003,12 +79405,13 @@ } } }, - "page-build": { + "milestone-opened": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.10/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-server@3.10/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.14/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.14/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -75089,7 +79492,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -75102,7 +79505,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -75111,13 +79514,13 @@ } } }, - "personal-access-token-request-approved": { + "organization-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.10/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was approved.", - "operationId": "personal-access-token-request/approved", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.14/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -75129,9 +79532,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -75139,15 +79542,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, + "example": "issues", "schema": { "type": "string" } @@ -75163,58 +79558,7 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "integration", - "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-personal-access-token-request-approved" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "personal_access_token_request", - "supported-webhook-types": [ - "app" - ] - } - } - }, - "personal-access-token-request-cancelled": { - "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.10/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was cancelled by the requester.", - "operationId": "personal-access-token-request/cancelled", - "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#personal_access_token_request" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", + "example": "repository", "schema": { "type": "string" } @@ -75228,41 +79572,25 @@ } }, { - "name": "X-Github-Event", - "in": "header", - "example": "personal_access_token_request", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Hub-Signature-256", "in": "header", - "example": 123123, + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "integration", + "example": "3.1.9", "schema": { "type": "string" } }, { - "name": "X-Hub-Signature-256", + "name": "X-GitHub-Enterprise-Host", "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "example": "ghes.github.com", "schema": { "type": "string" } @@ -75273,7 +79601,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -75286,20 +79614,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "organization", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "personal-access-token-request-created": { + "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.10/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was created.", - "operationId": "personal-access-token-request/created", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.14/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -75311,9 +79641,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -75321,15 +79651,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "personal_access_token_request", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, + "example": "issues", "schema": { "type": "string" } @@ -75345,58 +79667,7 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "integration", - "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-personal-access-token-request-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "personal_access_token_request", - "supported-webhook-types": [ - "app" - ] - } - } - }, - "personal-access-token-request-denied": { - "post": { - "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.10/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "description": "A fine-grained personal access token request was denied.", - "operationId": "personal-access-token-request/denied", - "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#personal_access_token_request" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", + "example": "repository", "schema": { "type": "string" } @@ -75410,41 +79681,25 @@ } }, { - "name": "X-Github-Event", - "in": "header", - "example": "personal_access_token_request", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Hub-Signature-256", "in": "header", - "example": 123123, + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "integration", + "example": "3.1.9", "schema": { "type": "string" } }, { - "name": "X-Hub-Signature-256", + "name": "X-GitHub-Enterprise-Host", "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "example": "ghes.github.com", "schema": { "type": "string" } @@ -75455,7 +79710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -75468,19 +79723,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "organization", "supported-webhook-types": [ + "organization", + "business", "app" ] } } }, - "ping": { + "organization-member-invited": { "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.14/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -75561,22 +79819,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -75588,26 +79831,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", - "app", "business", - "marketplace" + "app" ] } } }, - "project-card-converted": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.14/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -75688,7 +79928,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -75701,22 +79941,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "project-card-created": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a project (classic).", - "operationId": "project-card/created", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.14/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -75797,7 +80037,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -75810,22 +80050,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "project-card-deleted": { + "package-published": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was deleted.", - "operationId": "project-card/deleted", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.14/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -75906,7 +80146,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -75919,7 +80159,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -75928,13 +80168,13 @@ } } }, - "project-card-edited": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a project (classic) was edited.", - "operationId": "project-card/edited", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.14/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -76015,7 +80255,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-package-updated" } } } @@ -76028,7 +80268,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -76037,13 +80277,12 @@ } } }, - "project-card-moved": { + "page-build": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.14/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-server@3.14/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -76124,7 +80363,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -76137,7 +80376,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "page_build", "supported-webhook-types": [ "repository", "organization", @@ -76146,13 +80385,13 @@ } } }, - "project-closed": { + "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.14/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -76164,9 +80403,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -76174,31 +80413,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -76210,22 +80449,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -76233,7 +80456,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -76246,22 +80469,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "project-column-created": { + "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a project (classic).", - "operationId": "project-column/created", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.14/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -76273,9 +80494,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -76283,31 +80504,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -76319,22 +80540,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -76342,7 +80547,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -76355,22 +80560,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "project-column-deleted": { + "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a project (classic).", - "operationId": "project-column/deleted", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.14/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -76382,9 +80585,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -76392,31 +80595,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -76428,22 +80631,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -76451,7 +80638,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -76464,22 +80651,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "project-column-edited": { + "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a project (classic) was changed.", - "operationId": "project-column/edited", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.14/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -76491,9 +80676,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -76501,31 +80686,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -76537,22 +80722,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -76560,7 +80729,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -76573,22 +80742,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "project-column-moved": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a project (classic).", - "operationId": "project-column/moved", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -76669,7 +80835,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } } } } @@ -76681,23 +80862,26 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "project-created": { + "project-card-converted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -76778,7 +80962,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -76791,7 +80975,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -76800,13 +80984,13 @@ } } }, - "project-deleted": { + "project-card-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was deleted.", - "operationId": "project/deleted", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -76887,7 +81071,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-card-created" } } } @@ -76900,7 +81084,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -76909,13 +81093,13 @@ } } }, - "project-edited": { + "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a project (classic) was changed.", - "operationId": "project/edited", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -76996,7 +81180,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -77009,7 +81193,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -77018,13 +81202,13 @@ } } }, - "project-reopened": { + "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.10/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.10/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/reopened", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -77105,7 +81289,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -77118,7 +81302,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -77127,13 +81311,13 @@ } } }, - "projects-v2-closed": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was closed.", - "operationId": "projects-v2/closed", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -77155,7 +81339,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -77214,7 +81398,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -77226,22 +81410,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project_card", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-created": { + "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was created.", - "operationId": "projects-v2/created", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -77263,7 +81448,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -77322,7 +81507,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -77334,22 +81519,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-deleted": { + "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was deleted.", - "operationId": "projects-v2/deleted", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -77371,7 +81557,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -77430,7 +81616,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -77442,22 +81628,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-edited": { + "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The title, description, or README of a project in the organization was changed.", - "operationId": "projects-v2/edited", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -77479,7 +81666,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -77538,7 +81725,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -77550,22 +81737,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-archived": { + "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -77587,7 +81775,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -77646,7 +81834,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -77658,22 +81846,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-converted": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -77695,7 +81884,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -77754,7 +81943,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -77766,22 +81955,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project_column", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-created": { + "project-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was created.", + "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -77803,7 +81993,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -77862,7 +82052,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -77874,22 +82064,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-deleted": { + "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -77911,7 +82102,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -77970,7 +82161,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -77982,22 +82173,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-edited": { + "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -78019,7 +82211,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -78078,7 +82270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -78090,22 +82282,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-reordered": { + "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.14/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.14/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -78127,7 +82320,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -78186,7 +82379,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -78198,22 +82391,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "project", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-item-restored": { + "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -78235,7 +82429,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -78294,7 +82488,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -78308,20 +82502,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-reopened": { + "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.10/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was reopened.", - "operationId": "projects-v2/reopened", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -78402,7 +82596,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -78423,12 +82617,13 @@ } } }, - "public": { + "projects-v2-deleted": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -78450,7 +82645,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -78509,7 +82704,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -78521,23 +82716,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "public", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-assigned": { + "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -78559,7 +82753,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -78618,7 +82812,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -78630,23 +82824,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-disabled": { + "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -78668,7 +82861,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -78727,7 +82920,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -78739,23 +82932,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-auto-merge-enabled": { + "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -78777,7 +82969,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -78836,7 +83028,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -78848,23 +83040,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-closed": { + "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -78886,7 +83077,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -78945,7 +83136,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -78957,23 +83148,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-converted-to-draft": { + "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -78995,7 +83185,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -79054,7 +83244,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -79066,23 +83256,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-demilestoned": { + "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79104,7 +83293,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -79163,7 +83352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -79175,23 +83364,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-edited": { + "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79213,7 +83401,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -79272,7 +83460,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -79284,23 +83472,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-labeled": { + "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -79322,7 +83509,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2-item", "schema": { "type": "string" } @@ -79381,7 +83568,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -79393,23 +83580,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2_item", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-locked": { + "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.10/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.14/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -79431,7 +83617,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -79490,7 +83676,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -79502,23 +83688,21 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "pull-request-milestoned": { + "public": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -79599,7 +83783,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-public" } } } @@ -79612,7 +83796,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "public", "supported-webhook-types": [ "repository", "organization", @@ -79621,13 +83805,13 @@ } } }, - "pull-request-opened": { + "pull-request-assigned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -79708,7 +83892,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -79730,13 +83914,13 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-auto-merge-disabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -79817,7 +84001,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -79839,13 +84023,13 @@ } } }, - "pull-request-reopened": { + "pull-request-auto-merge-enabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -79926,7 +84110,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -79948,13 +84132,13 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-closed": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80035,7 +84219,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -80048,7 +84232,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -80057,13 +84241,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-converted-to-draft": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80144,7 +84328,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -80157,7 +84341,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -80166,13 +84350,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80253,7 +84437,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -80266,7 +84450,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -80275,13 +84459,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80362,7 +84546,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -80375,7 +84559,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -80384,13 +84568,13 @@ } } }, - "pull-request-review-edited": { + "pull-request-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80471,7 +84655,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -80484,7 +84668,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -80493,13 +84677,13 @@ } } }, - "pull-request-review-request-removed": { + "pull-request-locked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80580,7 +84764,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -80602,13 +84786,13 @@ } } }, - "pull-request-review-requested": { + "pull-request-milestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80689,7 +84873,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -80711,13 +84895,13 @@ } } }, - "pull-request-review-submitted": { + "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -80798,225 +84982,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request_review", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-thread-resolved": { - "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", - "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review_thread" - }, - "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" - } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request_review_thread", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-thread-unresolved": { - "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", - "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request_review_thread" - }, - "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" - } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -81029,7 +84995,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -81038,13 +85004,13 @@ } } }, - "pull-request-synchronize": { + "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81125,7 +85091,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -81147,13 +85113,13 @@ } } }, - "pull-request-unassigned": { + "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81234,7 +85200,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -81256,13 +85222,13 @@ } } }, - "pull-request-unlabeled": { + "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81343,7 +85309,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -81356,7 +85322,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -81365,13 +85331,13 @@ } } }, - "pull-request-unlocked": { + "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.10/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81452,7 +85418,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -81465,7 +85431,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -81474,12 +85440,13 @@ } } }, - "push": { + "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -81560,7 +85527,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -81573,7 +85540,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -81582,13 +85549,13 @@ } } }, - "registry-package-published": { + "pull-request-review-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.10/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -81669,7 +85636,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -81682,7 +85649,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -81691,13 +85658,13 @@ } } }, - "registry-package-updated": { + "pull-request-review-edited": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.10/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -81778,7 +85745,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -81791,7 +85758,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -81800,13 +85767,13 @@ } } }, - "release-created": { + "pull-request-review-request-removed": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.10/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-server@3.10/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.10/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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81887,7 +85854,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -81900,7 +85867,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -81909,13 +85876,13 @@ } } }, - "release-deleted": { + "pull-request-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.10/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-server@3.10/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.10/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 release was deleted.", - "operationId": "release/deleted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -81996,7 +85963,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" } } } @@ -82009,7 +85976,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -82018,13 +85985,13 @@ } } }, - "release-edited": { + "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.10/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-server@3.10/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.10/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -82105,7 +86072,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -82118,7 +86085,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -82127,13 +86094,13 @@ } } }, - "release-prereleased": { + "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.10/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-server@3.10/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.10/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", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -82214,7 +86181,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -82227,7 +86194,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -82236,13 +86203,13 @@ } } }, - "release-published": { + "pull-request-review-thread-unresolved": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.10/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-server@3.10/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.10/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", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -82323,7 +86290,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -82336,7 +86303,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -82345,13 +86312,13 @@ } } }, - "release-released": { + "pull-request-synchronize": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.10/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-server@3.10/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.10/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", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82432,7 +86399,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -82445,7 +86412,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -82454,13 +86421,13 @@ } } }, - "release-unpublished": { + "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.10/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-server@3.10/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.10/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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82541,7 +86508,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -82554,7 +86521,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -82563,13 +86530,13 @@ } } }, - "repository-anonymous-access-disabled": { + "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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": "Someone disabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", - "operationId": "repository/anonymous-access-disabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82650,7 +86617,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-anonymous-access-disabled" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -82663,23 +86630,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "pull_request", "supported-webhook-types": [ - "app", - "business", + "repository", "organization", - "repository" + "app" ] } } }, - "repository-anonymous-access-enabled": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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": "Someone enabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", - "operationId": "repository/anonymous-access-enabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -82760,7 +86726,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-anonymous-access-enabled" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -82773,23 +86739,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "pull_request", "supported-webhook-types": [ - "app", - "business", + "repository", "organization", - "repository" + "app" ] } } }, - "repository-archived": { + "push": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -82870,7 +86834,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-push" } } } @@ -82883,9 +86847,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "push", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -82893,13 +86856,13 @@ } } }, - "repository-created": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.14/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -82980,7 +86943,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -82993,9 +86956,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "registry_package", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83003,13 +86965,13 @@ } } }, - "repository-deleted": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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 there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.14/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -83090,7 +87052,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -83103,9 +87065,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "registry_package", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83113,12 +87074,13 @@ } } }, - "repository-dispatch-sample.collected": { + "release-created": { "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-server@3.10/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.14/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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83199,7 +87161,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -83212,20 +87174,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "release", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "release-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.14/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 release was deleted.", + "operationId": "release/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83306,7 +87270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -83319,9 +87283,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83329,13 +87292,13 @@ } } }, - "repository-privatized": { + "release-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.14/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-server@3.14/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83416,7 +87379,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -83429,9 +87392,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83439,13 +87401,13 @@ } } }, - "repository-publicized": { + "release-prereleased": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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 releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83526,7 +87488,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -83539,9 +87501,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83549,13 +87510,13 @@ } } }, - "repository-renamed": { + "release-published": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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 releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83636,7 +87597,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -83649,9 +87610,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83659,13 +87619,13 @@ } } }, - "repository-transferred": { + "release-released": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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 releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83746,7 +87706,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -83759,9 +87719,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83769,13 +87728,13 @@ } } }, - "repository-unarchived": { + "release-unpublished": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.10/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.10/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 releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -83856,7 +87815,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -83869,9 +87828,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "release", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -83879,13 +87837,13 @@ } } }, - "repository-vulnerability-alert-create": { + "repository-anonymous-access-disabled": { "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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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": "Someone disabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", + "operationId": "repository/anonymous-access-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -83966,7 +87924,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-anonymous-access-disabled" } } } @@ -83979,21 +87937,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ - "repository", - "organization" + "app", + "business", + "organization", + "repository" ] } } }, - "repository-vulnerability-alert-dismiss": { + "repository-anonymous-access-enabled": { "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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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": "Someone enabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", + "operationId": "repository/anonymous-access-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84074,7 +88034,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-anonymous-access-enabled" } } } @@ -84087,21 +88047,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ - "repository", - "organization" + "app", + "business", + "organization", + "repository" ] } } }, - "repository-vulnerability-alert-reopen": { + "repository-archived": { "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 repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84182,7 +88144,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -84195,21 +88157,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "repository-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 repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84290,7 +88254,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -84303,21 +88267,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "repository-deleted": { "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-server@3.10/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-server@3.10/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84398,7 +88364,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -84411,8 +88377,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -84420,13 +88387,12 @@ } } }, - "secret-scanning-alert-location-created": { + "repository-dispatch-sample.collected": { "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-server@3.10/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-server@3.10/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 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-server@3.14/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -84507,22 +88473,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-repository-dispatch-sample" } } } @@ -84534,24 +88485,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "secret-scanning-alert-reopened": { + "repository-edited": { "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-server@3.10/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-server@3.10/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84632,7 +88580,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -84645,8 +88593,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -84654,13 +88603,13 @@ } } }, - "secret-scanning-alert-resolved": { + "repository-privatized": { "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-server@3.10/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-server@3.10/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 repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84741,7 +88690,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -84754,8 +88703,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -84763,13 +88713,13 @@ } } }, - "secret-scanning-alert-revoked": { + "repository-publicized": { "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-server@3.10/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-server@3.10/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 repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84850,7 +88800,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -84863,8 +88813,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -84872,13 +88823,13 @@ } } }, - "security-advisory-published": { + "repository-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.10/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.10/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/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-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -84959,7 +88910,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -84972,20 +88923,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "security-advisory-updated": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.10/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.10/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/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-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed.", - "operationId": "security-advisory/updated", + "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-server@3.14/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-server@3.14/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.14/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -85043,22 +88997,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -85066,7 +89004,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -85079,20 +89017,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "repository_ruleset", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.10/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.10/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/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-server@3.10/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 repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.14/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -85150,22 +89090,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -85173,7 +89097,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -85186,19 +89110,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "repository_ruleset", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-and-analysis": { + "repository-ruleset-edited": { "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-server@3.10/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 repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-server@3.14/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-server@3.14/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.14/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -85256,22 +89183,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -85279,7 +89190,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -85292,7 +89203,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "repository_ruleset", "supported-webhook-types": [ "repository", "organization", @@ -85301,13 +89212,13 @@ } } }, - "sponsorship-cancelled": { + "repository-transferred": { "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-server@3.10/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-server@3.10/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-server@3.10/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -85388,7 +89299,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -85401,20 +89312,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository", "supported-webhook-types": [ - "sponsors_listing" + "business", + "repository", + "organization", + "app" ] } } }, - "sponsorship-created": { + "repository-unarchived": { "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-server@3.10/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-server@3.10/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-server@3.10/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -85495,7 +89409,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -85508,20 +89422,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository", "supported-webhook-types": [ - "sponsors_listing" + "business", + "repository", + "organization", + "app" ] } } }, - "sponsorship-edited": { + "repository-vulnerability-alert-create": { "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-server@3.10/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-server@3.10/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-server@3.10/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", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-server@3.10/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85602,7 +89519,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -85615,20 +89532,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "sponsorship-pending-cancellation": { + "repository-vulnerability-alert-dismiss": { "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-server@3.10/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-server@3.10/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-server@3.10/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", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-server@3.10/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85709,7 +89627,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -85722,20 +89640,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "sponsorship-pending-tier-change": { + "repository-vulnerability-alert-reopen": { "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-server@3.10/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-server@3.10/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-server@3.10/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 a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85816,7 +89735,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -85829,20 +89748,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "sponsorship-tier-changed": { + "repository-vulnerability-alert-resolve": { "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-server@3.10/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-server@3.10/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-server@3.10/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 a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -85923,7 +89843,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -85936,20 +89856,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization" ] } } }, - "star-created": { + "secret-scanning-alert-created": { "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-server@3.10/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-server@3.10/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.10/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 there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.14/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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86030,7 +89951,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -86043,7 +89964,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -86052,13 +89973,13 @@ } } }, - "star-deleted": { + "secret-scanning-alert-location-created": { "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-server@3.10/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-server@3.10/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.10/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 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-server@3.14/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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -86139,7 +90060,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$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" + } } } } @@ -86151,8 +90087,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "star", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -86161,12 +90098,13 @@ } } }, - "status": { + "secret-scanning-alert-reopened": { "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-server@3.10/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-server@3.10/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-server@3.10/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 a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.14/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-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86247,7 +90185,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -86260,7 +90198,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -86269,12 +90207,13 @@ } } }, - "team-add": { + "secret-scanning-alert-resolved": { "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-server@3.10/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 a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.14/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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86355,7 +90294,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -86368,7 +90307,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -86377,13 +90316,13 @@ } } }, - "team-added-to-repository": { + "secret-scanning-alert-validated": { "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-server@3.10/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", + "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-server@3.14/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-server@3.14/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 validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -86464,7 +90403,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -86477,22 +90416,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "team-created": { + "security-advisory-published": { "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-server@3.10/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", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.14/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.14/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -86573,7 +90512,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -86586,22 +90525,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "security_advisory", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "team-deleted": { + "security-advisory-updated": { "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-server@3.10/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", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.14/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.14/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -86682,7 +90619,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -86695,22 +90632,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "security_advisory", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "team-edited": { + "security-advisory-withdrawn": { "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-server@3.10/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 a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.14/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.14/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -86791,7 +90726,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -86804,22 +90739,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "security_advisory", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "team-removed-from-repository": { + "security-and-analysis": { "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-server@3.10/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 code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -86900,7 +90832,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -86913,129 +90845,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team", + "subcategory": "security_and_analysis", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "user-created": { - "post": { - "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-server@3.10/webhooks/webhook-events-and-payloads#user" - }, - "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" - } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-user-created" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": true, - "category": "webhooks", - "subcategory": "user", - "supported-webhook-types": [ - "business" - ] - } - } - }, - "user-deleted": { + "sponsorship-cancelled": { "post": { - "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", + "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-server@3.14/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-server@3.14/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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#user" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87116,7 +90941,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-user-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -87127,22 +90952,22 @@ } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "webhooks", - "subcategory": "user", + "subcategory": "sponsorship", "supported-webhook-types": [ - "business" + "sponsors_listing" ] } } }, - "watch-started": { + "sponsorship-created": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-server@3.10/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-server@3.10/rest/activity/watching)\" 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 started watching the repository.", - "operationId": "watch/started", + "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-server@3.14/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-server@3.14/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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87223,7 +91048,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -87236,21 +91061,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "watch", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "workflow-dispatch": { + "sponsorship-edited": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-server@3.10/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "workflow-dispatch", + "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-server@3.14/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-server@3.14/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-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87331,7 +91155,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -87344,20 +91168,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_dispatch", + "subcategory": "sponsorship", "supported-webhook-types": [ - "app" + "sponsors_listing" ] } } }, - "workflow-job-completed": { + "sponsorship-pending-cancellation": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.10/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", - "operationId": "workflow-job/completed", + "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-server@3.14/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-server@3.14/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-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87438,7 +91262,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -87451,23 +91275,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "sponsorship", "supported-webhook-types": [ - "business", - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "workflow-job-in-progress": { + "sponsorship-pending-tier-change": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.10/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run started processing on a runner.", - "operationId": "workflow-job/in-progress", + "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-server@3.14/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-server@3.14/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-server@3.14/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -87548,7 +91369,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -87561,9 +91382,222 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "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-server@3.14/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-server@3.14/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-server@3.14/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", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#sponsorship" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "star-created": { + "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-server@3.14/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-server@3.14/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.14/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-server@3.14/webhooks/webhook-events-and-payloads#star" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-star-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "star", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -87571,13 +91605,13 @@ } } }, - "workflow-job-queued": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.10/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created.", - "operationId": "workflow-job/queued", + "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-server@3.14/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-server@3.14/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -87658,7 +91692,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-queued" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -87671,9 +91705,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "star", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -87681,13 +91714,12 @@ } } }, - "workflow-job-waiting": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.10/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A job in a workflow run was created and is waiting for approvals.", - "operationId": "workflow-job/waiting", + "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-server@3.14/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-server@3.14/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -87768,7 +91800,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-job-waiting" + "$ref": "#/components/schemas/webhook-status" } } } @@ -87781,9 +91813,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_job", + "subcategory": "status", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -87791,13 +91822,12 @@ } } }, - "workflow-run-completed": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.10/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", - "operationId": "workflow-run/completed", + "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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -87878,7 +91908,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-completed" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -87891,9 +91921,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "team_add", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -87901,13 +91930,13 @@ } } }, - "workflow-run-in-progress": { + "team-added-to-repository": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.10/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run started processing on a runner.", - "operationId": "workflow-run/in-progress", + "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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -87988,7 +92017,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-in-progress" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -88001,23 +92030,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "team", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } }, - "workflow-run-requested": { + "team-created": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.10/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", - "description": "A workflow run was triggered.", - "operationId": "workflow-run/requested", + "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-server@3.14/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-server@3.10/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -88098,7 +92126,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-workflow-run-requested" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -88111,686 +92139,2218 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "workflow_run", + "subcategory": "team", "supported-webhook-types": [ - "business", - "repository", "organization", + "business", "app" ] } } - } - }, - "components": { - "schemas": { - "root": { - "type": "object", - "properties": { - "current_user_url": { - "type": "string", - "format": "uri-template" + }, + "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-server@3.14/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", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "current_user_authorizations_html_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "authorizations_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "code_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "commit_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "emails_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "emojis_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "events_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "feeds_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "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-server@3.14/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", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "followers_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "following_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "gists_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "hub_url": { - "type": "string", - "format": "uri-template", - "deprecated": true + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "issue_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "issues_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "keys_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "label_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "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-server@3.14/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", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "notifications_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "organization_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "organization_repositories_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "organization_teams_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "public_gists_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "rate_limit_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "repository_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "repository_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-removed-from-repository" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "user-created": { + "post": { + "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-server@3.14/webhooks/webhook-events-and-payloads#user" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "current_user_repositories_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "starred_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "starred_gists_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "topic_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "user_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "user_organizations_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "user_repositories_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "user_search_url": { - "type": "string", - "format": "uri-template" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-user-created" + } + } } }, - "required": [ - "current_user_url", - "current_user_authorizations_html_url", - "authorizations_url", - "code_search_url", - "commit_search_url", - "emails_url", - "emojis_url", - "events_url", - "feeds_url", - "followers_url", - "following_url", - "gists_url", - "issue_search_url", - "issues_url", - "keys_url", - "label_search_url", - "notifications_url", - "organization_url", - "organization_repositories_url", - "organization_teams_url", - "public_gists_url", - "rate_limit_url", - "repository_url", - "repository_search_url", - "current_user_repositories_url", - "starred_url", - "starred_gists_url", - "user_url", - "user_organizations_url", - "user_repositories_url", - "user_search_url" - ] - }, - "global-hook": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "user", + "supported-webhook-types": [ + "business" + ] + } + } + }, + "user-deleted": { + "post": { + "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-server@3.14/webhooks/webhook-events-and-payloads#user" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "name": { - "type": "string" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "active": { - "type": "boolean" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "events": { - "type": "array", - "items": { + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { "type": "string" } }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - }, - "secret": { - "type": "string" - } + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" } }, - "updated_at": { - "type": "string" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "created_at": { - "type": "string" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "url": { - "type": "string" + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "ping_url": { - "type": "string" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-user-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "user", + "supported-webhook-types": [ + "business" + ] } - }, - "global-hook-2": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "integer" + } + }, + "watch-started": { + "post": { + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-server@3.14/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-server@3.14/rest/activity/watching)\" 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 started watching the repository.", + "operationId": "watch/started", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#watch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "name": { - "type": "string" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "active": { - "type": "boolean" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "events": { - "type": "array", - "items": { + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { "type": "string" } }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "content_type": { - "type": "string" - }, - "insecure_ssl": { - "type": "string" - } + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" } }, - "updated_at": { - "type": "string" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "created_at": { - "type": "string" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "url": { - "type": "string" + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "ping_url": { - "type": "string" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-watch-started" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "watch", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] } - }, - "public-key-full": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "key": { - "type": "string" - }, - "user_id": { - "nullable": true, - "type": "integer" + } + }, + "workflow-dispatch": { + "post": { + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-server@3.14/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_dispatch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "repository_id": { - "nullable": true, - "type": "integer" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "url": { - "type": "string" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "title": { - "type": "string" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "read_only": { - "type": "boolean" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "verified": { - "type": "boolean" + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "created_at": { - "type": "string", - "format": "date-time" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "added_by": { - "type": "string", - "nullable": true + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "last_used": { - "nullable": true, - "type": "string", - "format": "date-time" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-dispatch" + } + } } }, - "required": [ - "id", - "key", - "url", - "title", - "verified", - "created_at", - "read_only", - "last_used", - "user_id", - "repository_id" - ] - }, - "ldap-mapping-team": { - "type": "object", - "properties": { - "ldap_dn": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "url": { - "type": "string" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "html_url": { - "type": "string" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "name": { - "type": "string" + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } }, - "slug": { - "type": "string" + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } }, - "description": { - "type": "string", - "nullable": true + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } }, - "privacy": { - "type": "string" + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } }, - "notification_setting": { - "type": "string" + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } }, - "permission": { - "type": "string" + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } }, - "members_url": { - "type": "string" + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } }, - "repositories_url": { - "type": "string" + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } }, - "parent": { - "nullable": true + { + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] } - }, - "ldap-mapping-user": { - "title": "Ldap Private User", - "description": "Ldap Private User", + } + }, + "workflow-job-queued": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created.", + "operationId": "workflow-job/queued", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-queued" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-waiting": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created and is waiting for approvals.", + "operationId": "workflow-job/waiting", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_job" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-waiting" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.14/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", + "operationId": "workflow-run/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_run" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-run-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.14/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run started processing on a runner.", + "operationId": "workflow-run/in-progress", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_run" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-run-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.14/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run was triggered.", + "operationId": "workflow-run/requested", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#workflow_run" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-run-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + } + }, + "components": { + "schemas": { + "root": { "type": "object", "properties": { - "ldap_dn": { - "type": "string" + "current_user_url": { + "type": "string", + "format": "uri-template" }, - "login": { + "current_user_authorizations_html_url": { "type": "string", - "example": "octocat" + "format": "uri-template" }, - "id": { - "type": "integer", - "example": 1 + "authorizations_url": { + "type": "string", + "format": "uri-template" }, - "node_id": { + "code_search_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "format": "uri-template" }, - "avatar_url": { + "commit_search_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "uri-template" }, - "gravatar_id": { + "emails_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "format": "uri-template" }, - "url": { + "emojis_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "format": "uri-template" }, - "html_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "format": "uri-template" + }, + "feeds_url": { + "type": "string", + "format": "uri-template" }, "followers_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "format": "uri-template" }, "following_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri-template" }, "gists_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri-template" }, - "starred_url": { + "hub_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri-template", + "deprecated": true }, - "subscriptions_url": { + "issue_search_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri-template" }, - "organizations_url": { + "issues_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "uri-template" }, - "repos_url": { + "keys_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "format": "uri-template" }, - "events_url": { + "label_search_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri-template" }, - "received_events_url": { + "notifications_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "uri-template" }, - "type": { + "organization_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "uri-template" }, - "name": { + "organization_repositories_url": { "type": "string", - "example": "monalisa octocat", - "nullable": true + "format": "uri-template" }, - "company": { + "organization_teams_url": { "type": "string", - "example": "GitHub", - "nullable": true + "format": "uri-template" }, - "blog": { + "public_gists_url": { "type": "string", - "example": "https://github.com/blog", - "nullable": true + "format": "uri-template" }, - "location": { + "rate_limit_url": { "type": "string", - "example": "San Francisco", - "nullable": true + "format": "uri-template" }, - "email": { + "repository_url": { "type": "string", - "format": "email", - "example": "octocat@github.com", - "nullable": true - }, - "hireable": { - "type": "boolean", - "nullable": true + "format": "uri-template" }, - "bio": { + "repository_search_url": { "type": "string", - "example": "There once was...", - "nullable": true + "format": "uri-template" }, - "twitter_username": { + "current_user_repositories_url": { "type": "string", - "example": "monalisa", - "nullable": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 + "format": "uri-template" }, - "created_at": { + "starred_url": { "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" + "format": "uri-template" }, - "updated_at": { + "starred_gists_url": { "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "private_gists": { - "type": "integer", - "example": 81 - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "disk_usage": { - "type": "integer", - "example": 10000 + "format": "uri-template" }, - "collaborators": { - "type": "integer", - "example": 8 + "topic_search_url": { + "type": "string", + "format": "uri-template" }, - "two_factor_authentication": { - "type": "boolean", - "example": true + "user_url": { + "type": "string", + "format": "uri-template" }, - "plan": { - "type": "object", - "properties": { - "collaborators": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - } - }, - "required": [ - "collaborators", - "name", - "space", - "private_repos" - ] + "user_organizations_url": { + "type": "string", + "format": "uri-template" }, - "suspended_at": { + "user_repositories_url": { "type": "string", - "format": "date-time", - "nullable": true + "format": "uri-template" }, - "business_plus": { - "type": "boolean" + "user_search_url": { + "type": "string", + "format": "uri-template" } }, "required": [ - "avatar_url", + "current_user_url", + "current_user_authorizations_html_url", + "authorizations_url", + "code_search_url", + "commit_search_url", + "emails_url", + "emojis_url", "events_url", + "feeds_url", "followers_url", "following_url", "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", + "issue_search_url", + "issues_url", + "keys_url", + "label_search_url", + "notifications_url", + "organization_url", + "organization_repositories_url", + "organization_teams_url", + "public_gists_url", + "rate_limit_url", + "repository_url", + "repository_search_url", + "current_user_repositories_url", "starred_url", - "subscriptions_url", - "type", - "url", - "bio", - "blog", - "company", - "email", - "followers", - "following", - "hireable", - "location", - "name", - "public_gists", - "public_repos", - "created_at", - "updated_at", - "collaborators", - "disk_usage", - "owned_private_repos", - "private_gists", - "total_private_repos", - "two_factor_authentication" + "starred_gists_url", + "user_url", + "user_organizations_url", + "user_repositories_url", + "user_search_url" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", + "global-hook": { "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" + "type": { + "type": "string" }, "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" + "type": "integer" }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" + "name": { + "type": "string" }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" + "active": { + "type": "boolean" }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" + "events": { + "type": "array", + "items": { + "type": "string" + } }, - "members_url": { + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + }, + "secret": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + } + } + }, + "global-hook-2": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + } + } + }, + "public-key-full": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "key": { + "type": "string" + }, + "user_id": { + "nullable": true, + "type": "integer" + }, + "repository_id": { + "nullable": true, + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "verified": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "added_by": { + "type": "string", + "nullable": true + }, + "last_used": { + "nullable": true, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only", + "last_used", + "user_id", + "repository_id" + ] + }, + "ldap-mapping-team": { + "type": "object", + "properties": { + "ldap_dn": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "nullable": true + } + } + }, + "ldap-mapping-user": { + "title": "Ldap Private User", + "description": "Ldap Private User", + "type": "object", + "properties": { + "ldap_dn": { + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": "string", + "example": "monalisa octocat", + "nullable": true + }, + "company": { + "type": "string", + "example": "GitHub", + "nullable": true + }, + "blog": { + "type": "string", + "example": "https://github.com/blog", + "nullable": true + }, + "location": { + "type": "string", + "example": "San Francisco", + "nullable": true + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, + "hireable": { + "type": "boolean", + "nullable": true + }, + "bio": { + "type": "string", + "example": "There once was...", + "nullable": true + }, + "twitter_username": { + "type": "string", + "example": "monalisa", + "nullable": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "private_gists": { + "type": "integer", + "example": 81 + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "disk_usage": { + "type": "integer", + "example": 10000 + }, + "collaborators": { + "type": "integer", + "example": 8 + }, + "two_factor_authentication": { + "type": "boolean", + "example": true + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "business_plus": { + "type": "boolean" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { "type": "string", "example": "https://api.github.com/orgs/github/members{/member}" }, @@ -88827,7 +94387,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -88926,7 +94487,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -88994,6 +94556,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -89071,6 +94634,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -89204,6 +94771,14 @@ "write" ] }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -89300,9 +94875,26 @@ "write" ] }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, "organization_copilot_seat_management": { "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] @@ -89355,7 +94947,7 @@ }, "organization_projects": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", @@ -89484,6 +95076,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -89561,6 +95154,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -89642,7 +95239,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -89736,6 +95334,438 @@ "expires_at" ] }, + "security-advisory-ecosystems": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, + "cvss-severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "security-advisory-credit-types": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "global-advisory": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true, + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": "string", + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": "string", + "format": "uri", + "description": "The URL of the advisory's source code.", + "nullable": true + }, + "identifiers": { + "type": "array", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": "array", + "nullable": true, + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "nvd_published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "vulnerabilities": { + "type": "array", + "description": "The products and respective version ranges affected by the advisory.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/vulnerability" + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "epss": { + "type": "object", + "nullable": true, + "properties": { + "percentage": { + "type": "number" + }, + "percentile": { + "type": "number" + } + } + }, + "credits": { + "type": "array", + "description": "In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available.", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false + }, + "basic-error": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "validation-error-simple": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, "integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -89833,10 +95863,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -89865,48 +95891,6 @@ "events" ] }, - "basic-error": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "validation-error-simple": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, "webhook-config-url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -89920,7 +95904,7 @@ }, "webhook-config-secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "webhook-config-insecure-ssl": { @@ -90017,6 +96001,13 @@ "type": "integer", "example": 123, "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true } }, "required": [ @@ -90191,6 +96182,13 @@ "example": 123, "nullable": true }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + }, "url": { "description": "The URL target of the delivery.", "type": "string", @@ -90543,7 +96541,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -90944,7 +96943,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -91149,6 +97148,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "url": { @@ -91245,7 +97245,7 @@ }, "announcement-message": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.10/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.14/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -92177,6 +98177,7 @@ "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", + "nullable": true, "enum": [ "open", "dismissed", @@ -92202,7 +98203,6 @@ "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "nullable": true, "enum": [ - null, "false positive", "won't fix", "used in tests" @@ -92226,14 +98226,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "nullable": true, "type": "string", @@ -92259,6 +98251,14 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -92380,6 +98380,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, @@ -92747,6 +98748,11 @@ "example": false, "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise." }, + "advanced_security_enabled_for_new_user_namespace_repositories": { + "type": "boolean", + "example": false, + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories." + }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, @@ -92919,6 +98925,9 @@ ], "additionalProperties": false }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "description": "Details for the advisory pertaining to Common Weakness Enumeration.", @@ -93227,7 +99236,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -93254,6 +99263,15 @@ "type": "string", "description": "The comment that was optionally added when this alert was closed", "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } }, @@ -93266,11 +99284,16 @@ "last_pushed_date": { "type": "string", "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" } }, "required": [ "user_login", - "last_pushed_date" + "last_pushed_date", + "last_pushed_email" ] }, "advanced-security-active-committers-repository": { @@ -93308,6 +99331,16 @@ "type": "integer", "example": 2 }, + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" + }, + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" + }, "repositories": { "type": "array", "items": { @@ -93558,10 +99591,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -93655,6 +99684,26 @@ "rocket" ] }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -93871,6 +99920,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -94242,6 +100294,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -94314,7 +100371,11 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" }, "node_id": { "type": "string" @@ -94394,6 +100455,11 @@ "format": "email", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -94449,11 +100515,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "private_gists": { "type": "integer", "example": 1 @@ -94754,6 +100815,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -95043,6 +101109,326 @@ "featured" ] }, + "ghes-get-ssh": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "format": "ssh-key", + "description": "The full public key" + }, + "fingerprint": { + "type": "string", + "format": "ssh-key fingerprint", + "description": "The fingerprint of the key" + } + } + } + }, + "ghes-set-ssh-request": { + "title": "Set SSH key", + "type": "object", + "properties": { + "key": { + "description": "The public SSH key to add to the `authorized_keys` file.", + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "ghes-set-ssh-response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname", + "description": "Hostname of the node where the SSH key was added." + }, + "uuid": { + "type": "string", + "format": "uuid", + "description": "UUID of the SSH key that was added." + }, + "message": { + "type": "string", + "description": "Message indicating the result of the SSH key addition." + }, + "error": { + "type": "string", + "description": "Error message indicating the reason for the SSH key addition failure. This field is only present if the SSH key addition failed." + }, + "modified": { + "type": "boolean", + "description": "Whether the SSH key was already present on the `authorized_keys` file." + } + } + } + }, + "ghes-delete-ssh-request": { + "title": "Set SSH key", + "type": "object", + "properties": { + "key": { + "description": "The public SSH key to remove from the `authorized_keys` file.", + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "ghes-delete-ssh-response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname", + "description": "Hostname of the node where the SSH key was removed." + }, + "uuid": { + "type": "string", + "format": "uuid", + "description": "UUID of the SSH key that was removed." + }, + "message": { + "type": "string", + "description": "Message indicating the result of the SSH key removal." + }, + "error": { + "type": "string", + "description": "Error message indicating the reason for the SSH key removal failure. This field is only present if the SSH key removal failed." + } + } + } + }, + "ghes-checks-result-indicator": { + "type": "string", + "enum": [ + "OK", + "FAILED" + ] + }, + "ghes-checks-system-requirements": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "roles_status": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "role": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "ghes-cluster-status-indicator": { + "type": "string", + "enum": [ + "UNKNOWN", + "OK", + "WARNING", + "CRITICAL" + ] + }, + "ghes-cluster-status": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "name": { + "type": "string" + }, + "details": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "ghes-config-init-request": { + "title": "Initialize configuration with license upload", + "type": "object", + "properties": { + "license": { + "type": "string", + "description": "The content of your _.ghl_ license file." + }, + "password": { + "type": "string", + "description": "The root site administrator password." + } + }, + "required": [ + "license", + "password" + ] + }, + "ghes-license-info": { + "type": "object", + "properties": { + "advancedSecurityEnabled": { + "description": "Whether the GitHub Advanced Security feature is enabled.", + "type": "boolean" + }, + "advancedSecuritySeats": { + "description": "If the GitHub Advanced Security feature is enabled, the seat count.", + "type": "integer" + }, + "clusterSupport": { + "description": "Whether the cluster support feature is enabled.", + "type": "boolean" + }, + "company": { + "description": "The company under which the license is issued.", + "type": "string" + }, + "croquetSupport": { + "description": "Whether the Github Connect feature is enabled.", + "type": "boolean" + }, + "customTerms": { + "description": "Whether this license is issued under custom terms.", + "type": "boolean" + }, + "evaluation": { + "description": "Wheter this license is issued as an evaluation license.", + "type": "boolean" + }, + "expireAt": { + "description": "The expiration date of the license.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "insightsEnabled": { + "description": "Whether the insights feature is enabled.", + "type": "boolean" + }, + "insightsExpireAt": { + "description": "If the insights feature is enabled, the expiration date.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "learningLabEvaluationExpires": { + "description": "If the learning lab feature is enabled, the expiration date.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "learningLabSeats": { + "description": "If the learning lab feature is enabled, the seat count.", + "type": "integer" + }, + "perpetual": { + "description": "Whether the perpetual feature is enabled.", + "type": "boolean" + }, + "referenceNumber": { + "description": "The unique reference number of the license.", + "type": "string" + }, + "seats": { + "description": "If the license is issued with limited seating, the seat count.", + "type": "integer" + }, + "sshAllowed": { + "description": "Whether the SSH feature is enabled.", + "type": "boolean" + }, + "supportKey": { + "description": "The support key of the license.", + "type": "string" + }, + "unlimitedSeating": { + "description": "Whether the license is issued with unlimited seat count.", + "type": "boolean" + } + } + }, + "ghes-upload-license-request": { + "title": "License upload form", + "type": "object", + "properties": { + "license": { + "type": "string", + "description": "The content of your _.ghl_ license file." + } + }, + "required": [ + "license" + ] + }, + "ghes-license-check": { + "type": "object", + "properties": { + "status": { + "description": "The license status of the currently active enterprise license.", + "type": "string", + "enum": [ + "valid", + "invalid", + "expired", + "cluster mode not supported" + ] + } + } + }, "ghes-cluster-topology": { "type": "string", "enum": [ @@ -95102,6 +101488,428 @@ } } }, + "ghes-get-settings": { + "type": "object", + "properties": { + "private_mode": { + "type": "boolean" + }, + "public_pages": { + "type": "boolean" + }, + "subdomain_isolation": { + "type": "boolean" + }, + "signup_enabled": { + "type": "boolean" + }, + "github_hostname": { + "type": "string" + }, + "identicons_host": { + "type": "string" + }, + "http_proxy": { + "nullable": true, + "type": "string" + }, + "auth_mode": { + "type": "string" + }, + "expire_sessions": { + "type": "boolean" + }, + "admin_password": { + "nullable": true, + "type": "string" + }, + "configuration_id": { + "type": "integer" + }, + "configuration_run_count": { + "type": "integer" + }, + "avatar": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "uri": { + "type": "string" + } + } + }, + "customer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "secret_key_data": { + "type": "string" + }, + "public_key_data": { + "type": "string" + } + } + }, + "license": { + "type": "object", + "properties": { + "seats": { + "type": "integer" + }, + "evaluation": { + "type": "boolean" + }, + "perpetual": { + "type": "boolean" + }, + "unlimited_seating": { + "type": "boolean" + }, + "support_key": { + "type": "string" + }, + "ssh_allowed": { + "type": "boolean" + }, + "cluster_support": { + "type": "boolean" + }, + "expire_at": { + "type": "string" + } + } + }, + "github_ssl": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "cert": { + "nullable": true, + "type": "string" + }, + "key": { + "nullable": true, + "type": "string" + } + } + }, + "ldap": { + "type": "object", + "properties": { + "host": { + "nullable": true, + "type": "string" + }, + "port": { + "type": "integer" + }, + "base": { + "type": "array", + "items": { + "type": "string" + } + }, + "uid": { + "nullable": true, + "type": "string" + }, + "bind_dn": { + "nullable": true, + "type": "string" + }, + "password": { + "nullable": true, + "type": "string" + }, + "method": { + "type": "string" + }, + "search_strategy": { + "type": "string" + }, + "user_groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "admin_group": { + "nullable": true, + "type": "string" + }, + "virtual_attribute_enabled": { + "type": "boolean" + }, + "recursive_group_search": { + "type": "boolean" + }, + "posix_support": { + "type": "boolean" + }, + "user_sync_emails": { + "type": "boolean" + }, + "user_sync_keys": { + "type": "boolean" + }, + "user_sync_interval": { + "type": "integer" + }, + "team_sync_interval": { + "type": "integer" + }, + "sync_enabled": { + "type": "boolean" + }, + "reconciliation": { + "type": "object", + "properties": { + "user": { + "nullable": true, + "type": "string" + }, + "org": { + "nullable": true, + "type": "string" + } + } + }, + "profile": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, + "mail": { + "nullable": true, + "type": "string" + }, + "key": { + "nullable": true, + "type": "string" + } + } + } + } + }, + "cas": { + "type": "object", + "properties": { + "url": { + "nullable": true, + "type": "string" + } + } + }, + "saml": { + "type": "object", + "properties": { + "sso_url": { + "nullable": true, + "type": "string" + }, + "certificate": { + "nullable": true, + "type": "string" + }, + "certificate_path": { + "nullable": true, + "type": "string" + }, + "issuer": { + "nullable": true, + "type": "string" + }, + "idp_initiated_sso": { + "type": "boolean" + }, + "disable_admin_demote": { + "type": "boolean" + } + } + }, + "github_oauth": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + }, + "organization_name": { + "type": "string" + }, + "organization_team": { + "type": "string" + } + } + }, + "smtp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "address": { + "type": "string" + }, + "authentication": { + "type": "string" + }, + "port": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "username": { + "type": "string" + }, + "user_name": { + "type": "string" + }, + "enable_starttls_auto": { + "type": "boolean" + }, + "password": { + "type": "string" + }, + "discard-to-noreply-address": { + "type": "boolean" + }, + "support_address": { + "type": "string" + }, + "support_address_type": { + "type": "string" + }, + "noreply_address": { + "type": "string" + } + } + }, + "ntp": { + "type": "object", + "properties": { + "primary_server": { + "type": "string" + }, + "secondary_server": { + "type": "string" + } + } + }, + "timezone": { + "nullable": true, + "type": "string" + }, + "snmp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "community": { + "type": "string" + } + } + }, + "syslog": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "nullable": true, + "type": "string" + }, + "protocol_name": { + "type": "string" + } + } + }, + "assets": { + "nullable": true, + "type": "string" + }, + "pages": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "collectd": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "nullable": true, + "type": "string" + }, + "port": { + "type": "integer" + }, + "encryption": { + "nullable": true, + "type": "string" + }, + "username": { + "nullable": true, + "type": "string" + }, + "password": { + "nullable": true, + "type": "string" + } + } + }, + "mapping": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "tileserver": { + "nullable": true, + "type": "string" + }, + "basemap": { + "type": "string" + }, + "token": { + "nullable": true, + "type": "string" + } + } + }, + "load_balancer": { + "nullable": true, + "type": "string" + } + } + }, "ghes-get-maintenance": { "type": "array", "items": { @@ -95322,15 +102130,6 @@ "192.0.2.1" ] }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -95378,12 +102177,55 @@ "example.com" ] } + }, + "actions_inbound": { + "type": "object", + "properties": { + "full_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "wildcard_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + }, + "artifact_attestations": { + "type": "object", + "properties": { + "trust_domain": { + "type": "string", + "example": [ + "example" + ] + }, + "services": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } } } }, "installed_version": { "type": "string", - "example": "3.10.0" + "example": "3.14.0" } }, "required": [ @@ -95453,6 +102295,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -96189,7 +103032,8 @@ "collaborators": { "type": "integer", "example": 8, - "nullable": true + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", @@ -96276,32 +103120,38 @@ "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -96322,6 +103172,11 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ @@ -96795,6 +103650,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -97611,6 +104467,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 79 }, "owner": { @@ -97703,6 +104560,546 @@ "updated_at" ] }, + "organization-fine-grained-permission": { + "title": "Organization Fine-Grained Permission", + "description": "A fine-grained permission that protects organization resources.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "name", + "description" + ] + }, + "organization-role": { + "title": "Organization Role", + "description": "Organization roles", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the role.", + "type": "string" + }, + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": "string", + "nullable": true + }, + "base_role": { + "type": "string", + "nullable": true, + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin" + ] + }, + "source": { + "type": "string", + "nullable": true, + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined" + ] + }, + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "description": "The date and time the role was created.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time the role was last updated.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "organization-custom-organization-role-create-schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the custom role.", + "type": "string" + }, + "description": { + "description": "A short description about the intended usage of this role or what permissions it grants.", + "type": "string" + }, + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "permissions" + ] + }, + "organization-custom-organization-role-update-schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the custom role.", + "type": "string" + }, + "description": { + "description": "A short description about the intended use of this role or the permissions it grants.", + "type": "string" + }, + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "nullable-team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + }, + "team-role-assignment": { + "title": "A Role Assignment for a Team", + "description": "The Relationship a Team has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + }, + "user-role-assignment": { + "title": "A Role Assignment for a User", + "description": "The Relationship a User has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "inherited_from": { + "description": "Team the user has gotten the role through", + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "package-version": { "title": "Package Version", "description": "A version of a software package", @@ -97871,6 +105268,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -97894,6 +105299,8 @@ "repositories_url", "permissions", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -97906,7 +105313,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." }, "owner": { "$ref": "#/components/schemas/simple-user" @@ -97952,6 +105359,14 @@ "type": "string", "description": "Date and time when the fine-grained personal access token was approved to access the organization." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -97974,6 +105389,8 @@ "repositories_url", "permissions", "access_granted_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -98096,6 +105513,207 @@ "updated_at" ] }, + "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" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "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": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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" + ] + }, "nullable-repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -98104,7 +105722,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -98505,7 +106124,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -98692,6 +106311,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -99159,6 +106779,11 @@ }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -99256,172 +106881,1231 @@ "description" ] }, - "team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "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 not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "repository-ruleset-bypass-actor": { + "title": "Repository Ruleset Bypass Actor", "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], "properties": { - "id": { - "description": "Unique identifier of the team", + "actor_id": { "type": "integer", - "example": 1 + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, - "node_id": { + "actor_type": { "type": "string", - "example": "MDQ6VGVhbTE=" + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset" }, - "url": { - "description": "URL for the team", + "bypass_mode": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + }, + "repository-ruleset-conditions": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + "repository-ruleset-conditions-repository-name-target": { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + "repository-ruleset-conditions-repository-id-target": { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + }, + "repository-ruleset-conditions-repository-property-spec": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" }, - "members_url": { + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + }, + "repository-ruleset-conditions-repository-property-target": { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + "org-ruleset-conditions": { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + } + ] }, - "name": { - "description": "Name of the team", + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + } + ] + } + ] + }, + "repository-rule-creation": { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "example": "Justice League" + "enum": [ + "creation" + ] + } + } + }, + "repository-rule-update": { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] }, - "description": { - "description": "Description of the team", + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + "repository-rule-deletion": { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "nullable": true, - "example": "A great team." + "enum": [ + "deletion" + ] + } + } + }, + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + "repository-rule-required-deployments": { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + "repository-rule-required-signatures": { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "example": "admin" + "enum": [ + "required_signatures" + ] + } + } + }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } }, - "privacy": { - "description": "The level of privacy this team should have", + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { "type": "string", - "example": "closed" + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, + "repository-rule-pull-request": { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] }, - "notification_setting": { - "description": "The notification setting the team has set", + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + "repository-rule-params-status-check-configuration": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { "type": "string", - "example": "notifications_enabled" + "description": "The status check context name that must be present on the commit." }, - "html_url": { + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + }, + "repository-rule-required-status-checks": { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "enum": [ + "required_status_checks" + ] }, - "repositories_url": { + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + "repository-rule-non-fast-forward": { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "enum": [ + "non_fast_forward" + ] + } + } + }, + "repository-rule-commit-message-pattern": { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] }, - "slug": { + "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-commit-author-email-pattern": { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "example": "justice-league" + "enum": [ + "commit_author_email_pattern" + ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "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-committer-email-pattern": { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_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-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", + "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": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "path", + "repository_id" ] }, - "nullable-team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "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": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + }, + "repository-rule-code-scanning": { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + "repository-rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + } + ] + }, + "repository-ruleset": { + "title": "Repository ruleset", "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], "properties": { "id": { - "description": "Unique identifier of the team", "type": "integer", - "example": 1 + "description": "The ID of the ruleset" }, - "node_id": { + "name": { "type": "string", - "example": "MDQ6VGVhbTE=" + "description": "The name of the ruleset" }, - "url": { - "description": "URL for the team", + "target": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "description": "The target of the ruleset.", + "enum": [ + "branch", + "tag", + "push" + ] }, - "members_url": { + "source_type": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] }, - "name": { - "description": "Name of the team", + "source": { "type": "string", - "example": "Justice League" + "description": "The name of the source" }, - "description": { - "description": "Description of the team", + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "current_user_can_bypass": { "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { "nullable": true, - "example": "A great team." + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { "type": "string", - "example": "admin" + "format": "date-time" }, - "privacy": { - "description": "The level of privacy this team should have", + "updated_at": { "type": "string", - "example": "closed" + "format": "date-time" + } + } + }, + "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." }, - "notification_setting": { - "description": "The notification setting the team has set", + "actor_id": { + "type": "integer", + "description": "The number that identifies the user.", + "nullable": true + }, + "actor_name": { "type": "string", - "example": "notifications_enabled" + "description": "The handle for the GitHub user account.", + "nullable": true }, - "html_url": { + "before_sha": { "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "description": "The first commit sha before the push evaluation." }, - "repositories_url": { + "after_sha": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "description": "The last commit sha in the push evaluation." }, - "slug": { + "ref": { "type": "string", - "example": "justice-league" + "description": "The ref name that the evaluation ran on." }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "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", + "nullable": true, + "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`. Null if no rules with `evaluate` enforcement status were run." + }, + "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", + "nullable": true, + "description": "The detailed failure message for the rule. Null if the rule passed." + } + } + } } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true + } }, "team": { "title": "Team", @@ -99748,6 +108432,11 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ @@ -100773,7 +109462,8 @@ "id": { "description": "The project card's ID", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -100967,6 +109657,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -101512,7 +110205,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -101533,7 +110227,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -101568,7 +110263,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -102020,8 +110716,9 @@ "properties": { "id": { "description": "The id of the environment.", - "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 56780428 }, "node_id": { "type": "string", @@ -102102,8 +110799,9 @@ }, "id": { "description": "Unique identifier of the deployment", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 42 }, "node_id": { "type": "string", @@ -102275,6 +110973,68 @@ "updated_at" ] }, + "activity": { + "title": "Activity", + "description": "Activity", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "before": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "description": "The SHA of the commit before the activity." + }, + "after": { + "type": "string", + "example": "827efc6d56897b048c772eb4087f854f46256132", + "description": "The SHA of the commit after the activity." + }, + "ref": { + "type": "string", + "example": "refs/heads/main", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "The time when the activity occurred." + }, + "activity_type": { + "type": "string", + "example": "force_push", + "enum": [ + "push", + "force_push", + "branch_deletion", + "branch_creation", + "pr_merge", + "merge_queue_merge" + ], + "description": "The type of the activity that was performed." + }, + "actor": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "id", + "node_id", + "before", + "after", + "ref", + "timestamp", + "activity_type", + "actor" + ] + }, "autolink": { "title": "Autolink reference", "description": "An autolink reference.", @@ -102527,7 +111287,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -102576,6 +111337,9 @@ }, "site_admin": { "type": "boolean" + }, + "user_view_type": { + "type": "string" } } } @@ -102725,12 +111489,19 @@ "site_admin": { "type": "boolean", "example": false + }, + "user_view_type": { + "type": "string", + "example": "public" } } }, "name": { "type": "string" }, + "client_id": { + "type": "string" + }, "description": { "type": "string" }, @@ -103137,10 +111908,26 @@ ] }, "author": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "committer": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "parents": { "type": "array", @@ -103635,7 +112422,8 @@ "id": { "description": "The id of the check.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "head_sha": { "description": "The SHA of the commit that is being checked.", @@ -103935,7 +112723,8 @@ "properties": { "id": { "type": "integer", - "example": 5 + "example": 5, + "format": "int64" }, "node_id": { "type": "string", @@ -104197,7 +112986,7 @@ }, "full_description": { "type": "string", - "description": "description of the rule used to detect the alert." + "description": "A description of the rule used to detect the alert." }, "tags": { "nullable": true, @@ -104434,6 +113223,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -104461,6 +113251,14 @@ "type": "string", "format": "date-time", "example": "2023-12-06T14:20:20.000Z" + }, + "schedule": { + "description": "The frequency of the periodic analysis.", + "nullable": true, + "type": "string", + "enum": [ + "weekly" + ] } } }, @@ -104490,21 +113288,20 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", "java-kotlin", "javascript-typescript", "python", - "ruby" + "ruby", + "swift" ] } } }, - "additionalProperties": true, - "required": [ - "state" - ] + "additionalProperties": false }, "code-scanning-default-setup-update-response": { "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.", @@ -104527,7 +113324,7 @@ "example": "refs/heads/main" }, "code-scanning-analysis-sarif-file": { - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.10/code-security/secure-coding/sarif-support-for-code-scanning).\"", + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.14/code-security/secure-coding/sarif-support-for-code-scanning).\"", "type": "string" }, "code-scanning-sarifs-receipt": { @@ -104646,6 +113443,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -104756,6 +113554,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -104790,6 +113592,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -104900,6 +113703,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -105109,6 +113916,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -105684,6 +114492,9 @@ "sha": { "type": "string" }, + "content": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -105720,9 +114531,6 @@ "path": { "type": "string" }, - "content": { - "type": "string" - }, "sha": { "type": "string" }, @@ -105819,9 +114627,7 @@ "sha", "size", "type", - "url", - "content", - "encoding" + "url" ] }, "content-directory": { @@ -106331,6 +115137,49 @@ } } }, + "secret-scanning-push-protection-bypass-placeholder-id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "repository-rule-violation-error": { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, "contributor": { "title": "Contributor", "description": "Contributor", @@ -106407,6 +115256,9 @@ }, "name": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -106666,6 +115518,11 @@ "example": "SPDX-2.3", "description": "The version of the SPDX specification that this document conforms to." }, + "comment": { + "type": "string", + "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/", + "description": "An optional comment about the SPDX document." + }, "creationInfo": { "type": "object", "properties": { @@ -106698,17 +115555,9 @@ "example": "CC0-1.0", "description": "The license under which the SPDX document is licensed." }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "example": "github/github" - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", - "example": "https://github.com/example/dependency_graph/sbom-123", + "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "description": "The namespace for the SPDX document." }, "packages": { @@ -106723,7 +115572,7 @@ }, "name": { "type": "string", - "example": "rubygems:github/github", + "example": "github/github", "description": "The name of the package." }, "versionInfo": { @@ -106756,6 +115605,11 @@ "example": "NOASSERTION", "description": "The distribution source of this package, or NOASSERTION if this was not determined." }, + "copyrightText": { + "type": "string", + "example": "Copyright (c) 1985 GitHub.com", + "description": "The copyright holders of the package, and any dates present with those notices, if available." + }, "externalRefs": { "type": "array", "items": { @@ -106791,10 +115645,33 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "licenseConcluded", - "licenseDeclared", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "example": "DEPENDS_ON", + "description": "The type of relationship between the two SPDX elements." + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -106804,7 +115681,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -107023,6 +115899,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -107060,7 +115937,7 @@ "example": "production" }, "target_url": { - "description": "Deprecated: the URL to associate with this status.", + "description": "Closing down notice: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", @@ -107150,7 +116027,8 @@ "id": { "description": "The id of the environment.", "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -107222,6 +116100,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" @@ -107294,13 +116177,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 }, @@ -107309,9 +116197,18 @@ "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" + ] } } }, @@ -107323,6 +116220,15 @@ "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": [ @@ -107965,7 +116871,8 @@ "id": { "description": "Unique identifier of the repository invitation.", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "repository": { "$ref": "#/components/schemas/minimal-repository" @@ -108238,6 +117145,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -109497,6 +118407,7 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 @@ -109517,6 +118428,7 @@ "type": "string" }, "description": { + "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true @@ -109527,6 +118439,7 @@ "type": "string" }, "default": { + "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } @@ -109942,14 +118855,16 @@ }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", - "example": 42, "type": "integer", + "format": "int64", + "example": 42, "nullable": true }, "id": { "description": "The ID of the pull request review comment.", - "example": 1, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { "description": "The node ID of the pull request review comment.", @@ -109967,12 +118882,12 @@ "type": "string" }, "position": { - "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", + "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", "example": 1, "type": "integer" }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", + "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", "example": 4, "type": "integer" }, @@ -110923,11 +119838,22 @@ "description": "The GitHub Pages deployment status.", "type": "object", "properties": { + "id": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit." + }, "status_url": { "type": "string", "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", - "example": "https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251" + "example": "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" }, "page_url": { "type": "string", @@ -110943,10 +119869,34 @@ } }, "required": [ + "id", "status_url", "page_url" ] }, + "pages-deployment-status": { + "title": "GitHub Pages deployment status", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the deployment.", + "enum": [ + "deployment_in_progress", + "syncing_files", + "finished_file_sync", + "updating_pages", + "purging_cdn", + "deployment_cancelled", + "deployment_failed", + "deployment_content_failed", + "deployment_attempt_error", + "deployment_lost", + "succeed" + ] + } + } + }, "repository-pre-receive-hook": { "type": "object", "properties": { @@ -110976,6 +119926,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -111166,596 +120117,13 @@ "type": "string" }, "repo": { - "type": "object", - "nullable": true, - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "spdx_id": { - "type": "string", - "nullable": true - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -111776,567 +120144,13 @@ "type": "string" }, "repo": { - "type": "object", - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -112544,7 +120358,8 @@ "id": { "description": "Unique identifier of the review", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -112648,11 +120463,13 @@ }, "pull_request_review_id": { "type": "integer", + "format": "int64", "example": 42, "nullable": true }, "id": { "type": "integer", + "format": "int64", "example": 10 }, "node_id": { @@ -113017,6 +120834,195 @@ "body" ] }, + "repository-rule-ruleset-info": { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + }, + "repository-rule-detailed": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule with ruleset details.", + "oneOf": [ + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + } + ] + }, "secret-scanning-alert": { "type": "object", "properties": { @@ -113066,7 +121072,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -113085,6 +121091,15 @@ "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } }, @@ -113149,6 +121164,64 @@ "commit_url" ] }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, "secret-scanning-location-issue-title": { "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", @@ -113247,7 +121320,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -113262,7 +121335,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -113321,6 +121394,7 @@ "type": "string", "enum": [ "commit", + "wiki_commit", "issue_title", "issue_body", "issue_comment", @@ -113341,6 +121415,9 @@ { "$ref": "#/components/schemas/secret-scanning-location-commit" }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, { "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, @@ -113376,11 +121453,7 @@ } ] } - }, - "required": [ - "type", - "details" - ] + } }, "stargazer": { "title": "Stargazer", @@ -114618,6 +122691,26 @@ } } }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "type": "string" }, @@ -115325,7 +123418,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -115443,6 +123537,9 @@ "type": "string", "format": "date-time", "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -115973,8 +124070,12 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, + "user_view_type": { + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -116073,6 +124174,12 @@ "example": "octocat@github.com", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -116160,11 +124267,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "business_plus": { "type": "boolean" }, @@ -116250,6 +124352,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 3 }, "name": { @@ -116311,7 +124414,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "primary_key_id": { "type": "integer" @@ -116428,7 +124532,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -116567,7 +124672,7 @@ }, "enterprise-webhooks": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts).\"\n", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.14/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -116635,7 +124740,7 @@ }, "simple-installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.14/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -116735,7 +124840,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -117038,6 +125144,11 @@ "type": "string" } }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "has_issues": { "description": "Whether issues are enabled.", "default": true, @@ -117503,7 +125614,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -117658,7 +125769,7 @@ }, "webhooks_rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -117811,6 +125922,7 @@ "strict_required_status_checks_policy", "signature_requirement_enforcement_level", "linear_history_requirement_enforcement_level", + "lock_branch_enforcement_level", "admin_enforced", "allow_force_pushes_enforcement_level", "allow_deletions_enforcement_level", @@ -117821,124 +125933,249 @@ "authorized_actor_names" ] }, - "simple-user-webhooks": { - "title": "Simple User", - "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "exemption-request-push-ruleset-bypass": { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] }, - "email": { - "nullable": true, - "type": "string" + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + "exemption-request-secret-scanning": { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] }, - "login": { + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "locations": { + "type": "array", + "description": "The location data of the secret that was detected", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "string", + "description": "The commit SHA where the secret was detected" + }, + "branch": { + "type": "string", + "description": "The branch where the secret was detected" + }, + "path": { + "type": "string", + "description": "The path of the file where the secret was detected" + } + } + } + } + } + } + } + } + }, + "exemption-request-secret-scanning-metadata": { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { "type": "string", - "example": "octocat" + "description": "The label for the secret type" }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + "exemption-response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { "id": { "type": "integer", - "example": 1 + "description": "The ID of the exemption response." }, - "node_id": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { "type": "string", - "example": "MDQ6VXNlcjE=" + "description": "The login of the user who reviewed the exemption request." }, - "avatar_url": { + "status": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, - "gravatar_id": { + "reviewer_comment": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "description": "The comment the reviewer provided when responding to the exemption request.", "nullable": true }, - "url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "exemption-request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "gists_url": { + "requester_login": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The login of the user who requested the exemption." }, - "starred_url": { + "request_type": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "exemption_request_data": { + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + }, + { + "$ref": "#/components/schemas/exemption-request-secret-scanning" + } + ] }, - "organizations_url": { + "resource_identifier": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "repos_url": { + "status": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] }, - "events_url": { + "requester_comment": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "received_events_url": { + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + } + ] + }, + "expires_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "type": { + "created_at": { "type": "string", - "example": "User" + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "site_admin": { - "type": "boolean" + "responses": { + "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/exemption-response" + } }, - "starred_at": { + "html_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", @@ -118184,11 +126421,11 @@ "type": "string" }, "webhooks_ref_0": { - "description": "The [`git ref`](https://docs.github.com/enterprise-server@3.10/rest/git/refs#get-a-reference) resource.", + "description": "The [`git ref`](https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference) resource.", "type": "string" }, "webhooks_deploy_key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { @@ -118342,6 +126579,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -118530,7 +126770,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -118575,6 +126816,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -118682,6 +126926,131 @@ "format": "date-time" }, "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", + "format": "int64" + }, + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "answer_chosen_at": { + "type": "string", + "nullable": true + }, + "answer_chosen_by": { "title": "User", "type": "object", "nullable": true, @@ -118766,127 +127135,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "parent_id", - "child_comment_count", - "repository_url", - "discussion_id", - "author_association", - "user", - "created_at", - "updated_at", - "body" - ] - }, - "discussion": { - "title": "Discussion", - "description": "A Discussion in a repository.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "answer_chosen_at": { - "type": "string", - "nullable": true - }, - "answer_chosen_by": { - "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": { + "user_view_type": { "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": [ @@ -119110,7 +127361,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -119155,12 +127407,21 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ "login", "id" ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } } }, "required": [ @@ -119324,7 +127585,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -119369,6 +127631,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -119512,7 +127777,7 @@ }, "webhooks_issue_comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -119616,6 +127881,153 @@ "format": "uri" }, "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", + "format": "int64" + }, + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "webhooks_changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "webhooks_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { "title": "User", "type": "object", "nullable": true, @@ -119701,149 +128113,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "html_url", - "issue_url", - "id", - "node_id", - "user", - "created_at", - "updated_at", - "author_association", - "performed_via_github_app", - "body", - "reactions" - ] - }, - "webhooks_changes": { - "description": "The changes to the comment.", - "type": "object", - "properties": { - "body": { - "type": "object", - "properties": { - "from": { - "description": "The previous version of the body.", - "type": "string" - } - }, - "required": [ - "from" - ] - } - } - }, - "webhooks_issue": { - "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", - "type": "object", - "properties": { - "active_lock_reason": { - "type": "string", - "nullable": true, - "enum": [ - "resolved", - "off-topic", - "too heated", - "spam", - null - ] - }, - "assignee": { - "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": { + "user_view_type": { "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", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ @@ -119939,6 +128211,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -120153,6 +128428,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -120413,6 +128691,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -120773,6 +129054,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -120803,6 +129104,145 @@ "format": "uri" }, "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", + "format": "int64" + }, + "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", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "webhooks_milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { "title": "User", "type": "object", "nullable": true, @@ -120888,141 +129328,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "url", - "repository_url", - "labels_url", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "assignees", - "milestone", - "comments", - "created_at", - "updated_at", - "closed_at", - "author_association", - "active_lock_reason", - "body", - "reactions" - ] - }, - "webhooks_milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "closed_at": { - "type": "string", - "nullable": true, - "format": "date-time" - }, - "closed_issues": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "creator": { - "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": { + "user_view_type": { "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", - "Mannequin" - ] - }, - "url": { - "type": "string", - "format": "uri" } }, "required": [ @@ -121102,7 +129410,7 @@ }, "webhooks_issue_2": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -121201,6 +129509,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121295,6 +129606,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121508,6 +129822,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121766,6 +130083,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122125,6 +130445,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -122194,7 +130534,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -122239,6 +130580,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122357,6 +130701,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122517,7 +130864,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -122820,6 +131168,11 @@ "type": "string" } }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "has_issues": { "description": "Whether issues are enabled.", "default": true, @@ -123285,7 +131638,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -123541,6 +131894,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123677,7 +132033,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -123722,6 +132079,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123875,6 +132235,14 @@ "type": "string", "description": "Date and time when the request for access was created." }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." @@ -123900,6 +132268,8 @@ "repository_count", "repositories", "created_at", + "token_id", + "token_name", "token_expired", "token_expires_at", "token_last_used_at" @@ -124017,6 +132387,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124164,6 +132537,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124432,6 +132808,56 @@ "archived_at" ] }, + "projects-v2-single-select-option": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "name" + ] + }, + "projects-v2-iteration-setting": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "duration": { + "type": "number", + "nullable": true + }, + "start_date": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "title" + ] + }, "webhooks_number": { "description": "The pull request number.", "type": "integer" @@ -124493,7 +132919,7 @@ ] }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**", "type": "boolean", "default": false } @@ -124724,6 +133150,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124943,6 +133372,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125171,7 +133603,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -125373,6 +133806,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125656,7 +134092,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -125701,6 +134138,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125962,7 +134402,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -126164,6 +134605,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126447,7 +134891,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -126492,6 +134937,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126676,6 +135124,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126787,6 +135238,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127314,7 +135768,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -127360,6 +135815,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127409,7 +135867,7 @@ }, "webhooks_review_comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -127680,7 +136138,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -127725,6 +136184,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127887,7 +136349,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -127932,6 +136395,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -127960,7 +136426,7 @@ }, "webhooks_release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -128214,6 +136680,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128360,7 +136829,7 @@ }, "webhooks_release_1": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -128639,6 +137108,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -128982,6 +137454,10 @@ "type": "string", "description": "The type of secret that secret scanning detected." }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -129027,6 +137503,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -129225,6 +137704,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -129319,6 +137801,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129411,6 +137896,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129680,6 +138168,70 @@ "id" ] }, + "webhook-branch-protection-configuration-disabled": { + "title": "branch protection configuration disabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "disabled" + ] + }, + "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" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-branch-protection-configuration-enabled": { + "title": "branch protection configuration enabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "enabled" + ] + }, + "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" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, "webhook-branch-protection-rule-created": { "title": "branch protection rule created event", "type": "object", @@ -129706,7 +138258,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -129742,7 +138294,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -129832,6 +138384,34 @@ "from" ] }, + "pull_request_reviews_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "require_last_push_approval": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, "required_status_checks": { "type": "object", "properties": { @@ -129880,7 +138460,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -129890,6 +138470,189 @@ "sender" ] }, + "webhook-exemption-request-cancelled": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-completed": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-created": { + "title": "Exemption request created event", + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-response-dismissed": { + "title": "Exemption response dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_dismissed" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, + "webhook-exemption-request-response-submitted": { + "title": "Exemption response submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_submitted" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, "webhook-cache-sync": { "type": "object", "properties": { @@ -129918,7 +138681,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -129951,7 +138714,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -129997,7 +138760,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -130053,7 +138816,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -130100,7 +138863,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -130134,7 +138897,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -130230,6 +138993,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -130322,6 +139090,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130893,7 +139664,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -130914,7 +139685,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -131011,6 +139782,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "Client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -131103,6 +139879,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131672,7 +140451,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131693,7 +140472,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -131785,6 +140564,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The Client ID for the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -131877,6 +140661,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132445,7 +141232,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -132565,6 +141352,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132761,7 +141551,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -132882,6 +141672,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133039,261 +141832,262 @@ "state": { "description": "State of a code scanning alert.", "type": "string", - "enum": [ - "dismissed", - "fixed" - ] - }, - "tool": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "nullable": true - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "version" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" - ] - }, - "commit_oid": { - "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "ref": { - "$ref": "#/components/schemas/webhooks_code_scanning_ref" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" - } - }, - "required": [ - "action", - "alert", - "ref", - "commit_oid", - "repository", - "sender" - ] - }, - "webhook-code-scanning-alert-created": { - "title": "code_scanning_alert created event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] - }, - "alert": { - "description": "The code scanning alert involved in the event.", - "type": "object", - "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "nullable": true, - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "dismissed_by": { - "nullable": true - }, - "dismissed_comment": { - "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true - }, - "fixed_at": { - "nullable": true - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": "object", + "enum": [ + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-created": { + "title": "code_scanning_alert created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "dismissed_by": { + "nullable": true + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true + }, + "fixed_at": { + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", "nullable": true, - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "category": { - "description": "Identifies the configuration under which the analysis was executed.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": "string", - "nullable": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", "enum": [ "open", "dismissed" @@ -133363,7 +142157,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133485,6 +142279,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133709,7 +142506,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -133963,7 +142760,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134182,7 +142979,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134206,7 +143003,7 @@ ] }, "comment": { - "description": "The [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment) resource.", + "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource.", "type": "object", "properties": { "author_association": { @@ -134358,7 +143155,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -134403,6 +143201,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134440,7 +143241,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134490,7 +143291,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134534,7 +143335,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134545,6 +143346,78 @@ "sender" ] }, + "webhook-dependabot-alert-auto-dismissed": { + "title": "Dependabot alert auto-dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_dismissed" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-auto-reopened": { + "title": "Dependabot alert auto-reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_reopened" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, "webhook-dependabot-alert-created": { "title": "Dependabot alert created event", "type": "object", @@ -134571,7 +143444,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134607,7 +143480,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134643,7 +143516,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134679,7 +143552,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134715,7 +143588,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134751,7 +143624,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134787,7 +143660,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -134809,7 +143682,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -134900,6 +143773,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135113,6 +143989,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135455,7 +144334,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -135550,6 +144429,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136259,6 +145141,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136358,7 +145243,7 @@ "$ref": "#/components/schemas/simple-installation" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } } }, @@ -136393,7 +145278,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -136524,6 +145409,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136739,6 +145627,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -137090,6 +145981,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -137237,227 +146131,233 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "url": { - "type": "string", - "format": "uri" - }, - "workflow_id": { - "type": "integer" - }, - "workflow_url": { - "type": "string" - } - }, - "required": [ - "id", - "name", - "node_id", - "head_branch", - "head_sha", - "run_number", - "event", - "status", - "conclusion", - "workflow_id", - "check_suite_id", - "check_suite_node_id", - "url", - "html_url", - "path", - "pull_requests", - "created_at", - "updated_at", - "actor", - "triggering_actor", - "run_attempt", - "run_started_at", - "display_title" - ] - } - }, - "required": [ - "action", - "workflow_run", - "since", - "repository", - "organization", - "sender" - ] - }, - "webhook-deployment-review-rejected": { - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "rejected" - ] - }, - "approver": { - "$ref": "#/components/schemas/webhooks_approver" - }, - "comment": { - "type": "string" - }, - "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" - }, - "reviewers": { - "$ref": "#/components/schemas/webhooks_reviewers" - }, - "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" - }, - "since": { - "type": "string" - }, - "workflow_job_run": { - "$ref": "#/components/schemas/webhooks_workflow_job_run" - }, - "workflow_job_runs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conclusion": { - "type": "string", - "nullable": true - }, - "created_at": { - "type": "string" - }, - "environment": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "name": { - "type": "string", - "nullable": true - }, - "status": { - "type": "string" - }, - "updated_at": { - "type": "string" - } - } - } - }, - "workflow_run": { - "title": "Deployment Workflow Run", - "type": "object", - "nullable": true, - "properties": { - "actor": { - "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": { + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "workflow_run", + "since", + "repository", + "organization", + "sender" + ] + }, + "webhook-deployment-review-rejected": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "rejected" + ] + }, + "approver": { + "$ref": "#/components/schemas/webhooks_approver" + }, + "comment": { + "type": "string" + }, + "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" + }, + "reviewers": { + "$ref": "#/components/schemas/webhooks_reviewers" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "since": { + "type": "string" + }, + "workflow_job_run": { + "$ref": "#/components/schemas/webhooks_workflow_job_run" + }, + "workflow_job_runs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conclusion": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "environment": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": "object", + "nullable": true, + "properties": { + "actor": { + "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" + }, + "user_view_type": { "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": [ @@ -137670,6 +146570,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -138021,6 +146924,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -138167,6 +147073,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138345,6 +147254,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138362,7 +147274,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -138497,6 +147409,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138709,6 +147624,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -139060,6 +147978,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -139207,6 +148128,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139370,7 +148294,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -139461,6 +148385,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -139675,6 +148602,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140005,7 +148935,7 @@ ] }, "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#list-deployment-statuses).", + "description": "The [deployment status](https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses).", "type": "object", "properties": { "created_at": { @@ -140096,6 +149026,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140308,6 +149241,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140636,7 +149572,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -140731,6 +149667,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141441,6 +150380,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141527,7 +150469,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141627,7 +150569,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141664,7 +150606,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141703,7 +150645,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141743,7 +150685,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141802,7 +150744,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141840,7 +150782,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141876,7 +150818,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141939,7 +150881,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141978,7 +150920,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142015,7 +150957,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142051,7 +150993,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142087,7 +151029,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142138,7 +151080,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142172,7 +151114,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142211,7 +151153,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142248,7 +151190,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142284,7 +151226,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142304,7 +151246,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142321,7 +151263,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142337,7 +151279,7 @@ "$ref": "#/components/schemas/enterprise-webhooks" }, "forkee": { - "description": "The created [`repository`](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository) resource.", + "description": "The created [`repository`](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository) resource.", "allOf": [ { "title": "Repository", @@ -142431,11 +151373,6 @@ } ] }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -142534,7 +151471,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -142719,6 +151657,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143240,8 +152181,7 @@ } } } - ], - "properties": {} + ] }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -143253,7 +152193,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143273,7 +152213,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143344,7 +152284,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143382,7 +152322,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143420,7 +152360,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143458,7 +152398,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143526,7 +152466,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143605,7 +152545,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143647,7 +152587,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143662,6 +152602,10 @@ "account": { "type": "object", "properties": { + "archived_at": { + "type": "string", + "nullable": true + }, "avatar_url": { "type": "string" }, @@ -143766,6 +152710,9 @@ }, "website_url": { "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143821,7 +152768,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "target_type": { "type": "string" @@ -143864,7 +152811,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -143885,7 +152832,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -144028,7 +152975,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -144073,6 +153021,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144103,11 +153054,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -144207,6 +153158,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144302,6 +153256,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144516,6 +153473,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144776,6 +153736,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145137,6 +154100,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -145206,7 +154189,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -145252,6 +154236,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145377,6 +154364,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145567,7 +154557,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -145618,7 +154609,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145649,11 +154640,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -145753,6 +154744,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145848,6 +154842,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146062,6 +155059,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146320,6 +155320,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146679,6 +155682,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -146748,7 +155771,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -146794,6 +155818,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146919,6 +155946,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147109,7 +156139,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -147140,6 +156171,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -147160,7 +156194,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147194,11 +156228,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -147298,6 +156332,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147393,6 +156430,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147607,6 +156647,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147867,6 +156910,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148227,6 +157273,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -148296,7 +157362,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -148342,6 +157409,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148467,6 +157537,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148657,7 +157730,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -148708,7 +157782,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148750,7 +157824,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148778,11 +157852,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -148882,6 +157956,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148977,6 +158054,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149191,6 +158271,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149452,6 +158535,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -149812,6 +158898,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -149881,7 +158987,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -149927,6 +159034,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150115,7 +159225,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -150146,6 +159257,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -150164,7 +159278,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -150192,7 +159306,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -150291,6 +159405,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150598,6 +159715,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150857,6 +159977,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151216,6 +160339,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -151285,7 +160428,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -151330,6 +160474,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151369,7 +160516,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -151397,7 +160544,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -151852,6 +160999,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -152103,6 +161253,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -152448,6 +161601,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -152521,7 +161694,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -152567,6 +161741,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -152582,7 +161759,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -152640,7 +161817,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -152740,6 +161917,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153049,6 +162229,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153310,6 +162493,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153670,6 +162856,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -153739,7 +162945,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -153785,6 +162992,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -153827,7 +163037,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -153856,7 +163066,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -153956,6 +163166,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154265,6 +163478,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154525,6 +163741,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154885,6 +164104,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -154954,7 +164193,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -155000,6 +164240,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155042,7 +164285,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -155070,7 +164313,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -155197,6 +164440,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -155291,6 +164537,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -155526,6 +164775,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -155779,6 +165031,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -156123,6 +165378,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -156196,7 +165471,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -156241,6 +165517,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -156253,7 +165532,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -156281,7 +165560,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -156734,6 +166013,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -156986,6 +166268,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -157331,6 +166616,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -157404,7 +166709,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -157449,6 +166755,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -157464,7 +166773,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -157490,7 +166799,7 @@ "properties": { "old_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "nullable": true, "properties": { @@ -157590,6 +166899,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157684,6 +166996,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157897,6 +167212,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158155,6 +167473,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158514,6 +167835,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -158583,7 +167924,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -158628,6 +167970,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -158752,6 +168097,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -158854,7 +168204,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -159039,6 +168390,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159270,7 +168624,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -159369,6 +168723,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159463,6 +168820,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159677,6 +169037,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159938,6 +169301,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160298,6 +169664,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -160367,7 +169753,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -160412,6 +169799,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160451,7 +169841,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160487,7 +169877,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160515,7 +169905,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -160970,6 +170360,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -161223,6 +170616,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -161569,6 +170965,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -161642,7 +171058,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -161688,6 +171105,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -161700,7 +171120,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -161725,7 +171145,7 @@ "properties": { "new_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -161824,6 +171244,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -161918,6 +171341,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162131,6 +171557,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162389,6 +171818,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162748,6 +172180,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -162817,7 +172269,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -162862,6 +172315,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162986,6 +172442,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -163089,7 +172550,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -163274,6 +172736,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163514,7 +172979,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163555,7 +173020,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163594,7 +173059,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163622,7 +173087,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -163749,6 +173214,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -163843,6 +173311,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -164078,6 +173549,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -164329,6 +173803,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -164673,6 +174150,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -164746,7 +174243,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -164791,6 +174289,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -164803,7 +174304,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164839,7 +174340,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164875,7 +174376,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164910,7 +174411,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164988,7 +174489,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165058,7 +174559,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165125,7 +174626,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165162,7 +174663,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165289,6 +174790,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165427,6 +174931,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165596,7 +175103,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165631,7 +175138,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165667,7 +175174,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165703,7 +175210,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165781,7 +175288,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165818,7 +175325,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165854,7 +175361,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165889,7 +175396,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166028,6 +175535,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166073,7 +175583,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -166112,7 +175622,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166161,7 +175671,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166352,6 +175862,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166451,6 +175964,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166887,6 +176403,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167036,7 +176555,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167176,6 +176695,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167274,6 +176796,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167484,6 +177009,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167639,7 +177167,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167654,7 +177182,7 @@ "type": "object", "properties": { "build": { - "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.10/rest/pages/pages#list-github-pages-builds) itself.", + "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.14/rest/pages/pages#list-github-pages-builds) itself.", "type": "object", "properties": { "commit": { @@ -167764,6 +177292,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167809,7 +177340,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -167832,11 +177363,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -167863,11 +177397,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -167894,11 +177431,14 @@ "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -167908,8 +177448,7 @@ "action", "personal_access_token_request", "organization", - "sender", - "installation" + "sender" ] }, "webhook-personal-access-token-request-denied": { @@ -167928,8 +177467,11 @@ "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -168047,7 +177589,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "zen": { "description": "Random string of GitHub zen.", @@ -168113,7 +177655,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168149,7 +177691,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168291,6 +177833,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168340,7 +177885,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168395,7 +177940,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168558,6 +178103,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168712,7 +178260,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168747,7 +178295,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168782,7 +178330,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168816,7 +178364,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168866,7 +178414,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168901,7 +178449,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168936,7 +178484,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -168971,7 +178519,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169035,7 +178583,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169069,7 +178617,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169098,7 +178646,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169128,7 +178676,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169158,7 +178706,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169241,7 +178789,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169275,7 +178823,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169323,7 +178871,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169354,7 +178902,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169384,7 +178932,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169405,6 +178953,7 @@ ] }, "changes": { + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.", "oneOf": [ { "type": "object", @@ -169417,6 +178966,46 @@ }, "field_type": { "type": "string" + }, + "field_name": { + "type": "string" + }, + "project_number": { + "type": "integer" + }, + "from": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] + }, + "to": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] } } } @@ -169458,7 +179047,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169506,7 +179095,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169540,7 +179129,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169571,7 +179160,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169598,7 +179187,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169854,6 +179443,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169949,6 +179541,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170073,6 +179668,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170301,7 +179899,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -170503,6 +180102,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170642,7 +180244,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -170786,7 +180388,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -170831,6 +180434,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171094,7 +180700,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -171296,6 +180903,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171435,7 +181045,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -171579,7 +181189,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -171624,6 +181235,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171807,6 +181421,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171918,6 +181535,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172100,6 +181720,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172455,7 +182078,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -172501,6 +182125,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172552,7 +182179,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172808,6 +182435,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173026,6 +182656,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173254,7 +182887,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -173456,6 +183090,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173595,7 +183232,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -173739,7 +183376,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -173784,6 +183422,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174045,7 +183686,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -174247,6 +183889,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174386,7 +184031,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -174530,7 +184175,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -174575,6 +184221,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174758,6 +184407,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174868,6 +184520,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175050,6 +184705,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175405,7 +185063,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -175451,6 +185110,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175505,7 +185167,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175761,6 +185423,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175979,6 +185644,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176207,7 +185875,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -176409,6 +186078,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176548,7 +186220,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -176692,7 +186364,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -176737,6 +186410,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177200,6 +186876,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177339,7 +187018,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -177483,7 +187162,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -177528,6 +187208,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177711,6 +187394,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177822,6 +187508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178004,6 +187693,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178359,7 +188051,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -178405,6 +188098,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178459,7 +188155,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178499,7 +188195,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178539,7 +188235,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178579,7 +188275,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178679,7 +188375,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178938,6 +188634,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179157,6 +188856,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179385,7 +189087,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -179587,6 +189290,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179726,7 +189432,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -179870,7 +189576,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -179915,6 +189622,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180178,7 +189888,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -180380,6 +190091,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180519,7 +190233,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -180663,7 +190377,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -180708,6 +190423,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180892,6 +190610,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181003,6 +190724,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181185,6 +190909,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181540,7 +191267,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -181586,6 +191314,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181637,7 +191368,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181892,6 +191623,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182111,6 +191845,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182339,7 +192076,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -182541,6 +192279,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182680,7 +192421,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -182824,7 +192565,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -182869,6 +192611,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183132,7 +192877,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -183334,6 +193080,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183473,7 +193222,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -183617,7 +193366,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -183662,6 +193412,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183846,6 +193599,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183956,6 +193712,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184138,6 +193897,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184493,7 +194255,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184539,6 +194302,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184590,7 +194356,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184630,7 +194396,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184669,7 +194435,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184709,7 +194475,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184749,7 +194515,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -184772,7 +194538,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -185044,7 +194810,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -185089,6 +194856,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185353,6 +195123,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185572,6 +195345,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185800,7 +195576,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -186002,6 +195779,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186141,7 +195921,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -186285,7 +196065,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -186330,6 +196111,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186577,7 +196361,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -186779,6 +196564,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186918,7 +196706,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -187061,7 +196849,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187106,6 +196895,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187292,6 +197084,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187469,6 +197264,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187818,7 +197616,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187864,6 +197663,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187913,7 +197715,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -188164,6 +197966,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188382,6 +198187,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188610,7 +198418,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -188812,6 +198621,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188951,7 +198763,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -189095,7 +198907,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -189140,6 +198953,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189387,7 +199203,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -189589,6 +199406,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189728,7 +199548,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -189872,7 +199692,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -189917,6 +199738,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190102,6 +199926,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190278,6 +200105,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190618,7 +200448,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -190664,6 +200495,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190713,7 +200547,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -190967,6 +200801,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191061,6 +200898,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191185,6 +201025,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191413,7 +201256,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -191615,6 +201459,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191754,7 +201601,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -191898,7 +201745,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -191943,6 +201791,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192190,7 +202041,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -192392,6 +202244,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192531,7 +202386,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -192675,7 +202530,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -192720,6 +202576,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192906,6 +202765,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193082,6 +202944,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193422,7 +203287,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193465,6 +203331,9 @@ "Mannequin" ] }, + "user_view_type": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -193517,7 +203386,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -193768,6 +203637,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193987,6 +203859,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194215,7 +204090,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -194417,6 +204293,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194556,7 +204435,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -194700,7 +204579,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -194745,6 +204625,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194992,7 +204875,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -195194,6 +205078,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195333,7 +205220,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -195477,7 +205364,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -195522,6 +205410,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195707,6 +205598,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195884,6 +205778,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196233,7 +206130,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196279,6 +206177,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196459,7 +206360,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196505,6 +206407,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196528,7 +206433,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -196795,6 +206700,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197014,6 +206922,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197237,7 +207148,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -197422,6 +207334,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197678,7 +207593,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -197723,6 +207639,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197965,7 +207884,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -198150,6 +208070,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198406,7 +208329,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -198451,6 +208375,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198637,6 +208564,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198814,6 +208744,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199163,7 +209096,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199209,6 +209143,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199263,7 +209200,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -199522,6 +209459,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199616,6 +209556,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199740,6 +209683,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199968,7 +209914,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -200170,6 +210117,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200309,7 +210259,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -200453,7 +210403,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -200498,6 +210449,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200759,7 +210713,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -200961,6 +210916,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201100,7 +211058,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -201244,7 +211202,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -201289,6 +211248,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201472,6 +211434,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201582,6 +211547,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201763,6 +211731,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202127,7 +212098,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202172,6 +212144,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202307,6 +212282,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202315,7 +212293,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -202571,6 +212549,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202665,6 +212646,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202789,6 +212773,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203017,7 +213004,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -203219,6 +213207,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203358,7 +213349,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -203502,7 +213493,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -203547,6 +213539,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203808,7 +213803,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -204010,6 +214006,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204149,7 +214148,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -204293,7 +214292,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -204338,6 +214338,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204521,6 +214524,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204631,6 +214637,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204812,6 +214821,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205176,7 +215188,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -205221,6 +215234,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205410,7 +215426,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -205672,6 +215688,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205767,6 +215786,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205891,6 +215913,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206119,7 +216144,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -206321,6 +216347,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206460,7 +216489,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -206604,7 +216633,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -206649,6 +216679,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206910,7 +216943,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -207112,6 +217146,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207251,7 +217288,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -207395,7 +217432,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -207440,6 +217478,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207623,6 +217664,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207734,6 +217778,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207915,6 +217962,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208270,7 +218320,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -208316,6 +218367,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208452,6 +218506,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208460,7 +218517,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -208717,6 +218774,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208812,6 +218872,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208936,6 +218999,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209164,7 +219230,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -209366,6 +219433,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209505,7 +219575,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -209649,7 +219719,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -209694,6 +219765,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209955,7 +220029,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -210157,6 +220232,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210296,7 +220374,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -210440,7 +220518,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -210485,6 +220564,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210668,6 +220750,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210779,6 +220864,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210960,6 +221048,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211306,7 +221397,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -211352,6 +221444,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211532,7 +221627,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -211785,6 +221880,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212004,6 +222102,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212232,7 +222333,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -212434,6 +222536,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212573,7 +222678,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -212717,7 +222822,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -212762,6 +222868,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213010,7 +223119,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -213212,6 +223322,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213351,7 +223464,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -213495,7 +223608,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -213540,6 +223654,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213726,6 +223843,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213903,6 +224023,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214252,7 +224375,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214298,6 +224422,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214352,7 +224479,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -214601,6 +224728,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214819,6 +224949,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215047,7 +225180,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -215232,6 +225366,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215493,7 +225630,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -215538,6 +225676,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215786,7 +225927,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -215971,6 +226113,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216232,7 +226377,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -216277,6 +226423,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216462,6 +226611,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216639,6 +226791,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216988,7 +227143,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217034,6 +227190,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217085,7 +227244,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -217094,7 +227253,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -217366,7 +227525,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217412,6 +227572,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217704,6 +227867,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217921,6 +228087,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218149,7 +228318,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -218334,6 +228504,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218595,7 +228768,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -218640,6 +228814,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218886,7 +229063,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -219071,6 +229249,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219332,7 +229513,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -219377,6 +229559,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219562,6 +229747,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219738,6 +229926,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220078,7 +230269,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220123,6 +230315,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220174,7 +230369,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -220183,7 +230378,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -220454,7 +230649,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220499,6 +230695,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220804,6 +231003,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221023,6 +231225,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221251,7 +231456,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -221453,6 +231659,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221592,7 +231801,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -221736,7 +231945,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -221781,6 +231991,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222042,7 +232255,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -222244,6 +232458,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222383,7 +232600,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -222527,7 +232744,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222572,6 +232790,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222755,6 +232976,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222866,6 +233090,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223048,6 +233275,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223403,7 +233633,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -223449,6 +233680,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223500,7 +233734,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -223761,6 +233995,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223980,6 +234217,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224209,7 +234449,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -224411,6 +234652,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224550,7 +234794,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -224694,7 +234938,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -224739,6 +234984,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225002,7 +235250,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -225204,6 +235453,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225343,7 +235595,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -225487,7 +235739,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -225532,6 +235785,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225716,6 +235972,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225827,6 +236086,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226009,6 +236271,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226364,7 +236629,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226410,6 +236676,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226461,7 +236730,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -226719,6 +236988,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226938,6 +237210,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227166,7 +237441,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -227368,6 +237644,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227507,7 +237786,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -227651,7 +237930,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -227696,6 +237976,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227959,7 +238242,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -228161,6 +238445,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228300,7 +238587,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -228444,7 +238731,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -228489,6 +238777,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228672,6 +238963,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228783,6 +239077,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228965,6 +239262,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229320,7 +239620,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -229366,6 +239667,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229417,7 +239721,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -229672,6 +239976,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229889,6 +240196,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230117,7 +240427,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -230319,6 +240630,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230458,7 +240772,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -230602,7 +240916,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -230647,6 +240962,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230909,7 +241227,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -231111,6 +241430,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231250,7 +241572,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -231394,7 +241716,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -231439,6 +241762,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231622,6 +241948,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231732,6 +242061,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231913,6 +242245,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232259,7 +242594,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -232304,6 +242640,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232355,7 +242694,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232382,7 +242721,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.10/rest/commits) to fetch additional commits.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.14/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -232763,6 +243102,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -232866,7 +243210,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -233051,6 +243396,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233270,7 +243618,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233388,6 +243736,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233474,6 +243825,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -233933,6 +244287,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -234052,7 +244409,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -234159,6 +244516,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234244,6 +244604,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234427,6 +244790,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -234567,7 +244933,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -234602,7 +244968,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -234638,7 +245004,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -234715,7 +245081,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -234746,7 +245112,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -235025,6 +245391,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -235152,7 +245521,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235187,7 +245556,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235222,7 +245591,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235257,7 +245626,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235288,7 +245657,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235317,7 +245686,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235347,7 +245716,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235379,7 +245748,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235411,7 +245780,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235450,7 +245819,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235537,7 +245906,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235570,7 +245939,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235602,7 +245971,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235661,7 +246030,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235671,6 +246040,260 @@ "sender" ] }, + "webhook-repository-ruleset-created": { + "title": "repository ruleset created event", + "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" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, + "webhook-repository-ruleset-deleted": { + "title": "repository ruleset deleted event", + "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" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, + "webhook-repository-ruleset-edited": { + "title": "repository ruleset edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "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" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "enforcement": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "conditions": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + }, + "deleted": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "condition": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "changes": { + "type": "object", + "properties": { + "condition_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "target": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "include": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "exclude": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "rules": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "deleted": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/repository-rule" + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, "webhook-repository-transferred": { "title": "repository transferred event", "type": "object", @@ -235799,7 +246422,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -235844,6 +246468,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235876,7 +246503,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235909,7 +246536,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -235944,7 +246571,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236093,6 +246720,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -236150,7 +246780,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236186,7 +246816,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236386,7 +247016,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236422,7 +247052,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236457,7 +247087,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236506,7 +247136,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236541,7 +247171,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236550,14 +247180,14 @@ "repository" ] }, - "webhook-secret-scanning-alert-revoked": { - "title": "secret_scanning_alert revoked event", + "webhook-secret-scanning-alert-validated": { + "title": "secret_scanning_alert validated event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "revoked" + "validated" ] }, "alert": { @@ -236576,7 +247206,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236611,7 +247241,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236645,7 +247275,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236695,6 +247325,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -236831,7 +247464,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236869,7 +247502,7 @@ "$ref": "#/components/schemas/full-repository" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -236900,7 +247533,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -236935,7 +247568,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -236987,7 +247620,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -237026,7 +247659,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -237067,7 +247700,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -237106,7 +247739,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -237142,7 +247775,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -237180,7 +247813,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -237684,7 +248317,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sha": { "description": "The Commit SHA.", @@ -237742,7 +248375,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -237865,6 +248498,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -237963,7 +248601,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -238148,6 +248787,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238362,7 +249004,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -238485,6 +249127,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -238583,7 +249230,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -238768,6 +249416,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -238982,7 +249633,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -239106,6 +249757,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -239204,7 +249860,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -239389,6 +250046,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -239603,7 +250263,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -239813,6 +250473,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -239911,7 +250576,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -240096,6 +250762,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240310,7 +250979,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -240435,6 +251104,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -240533,7 +251207,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -240718,6 +251393,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -240932,7 +251610,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -240967,7 +251645,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -240999,7 +251677,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -241032,7 +251710,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -241066,7 +251744,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "type": "string" @@ -241103,7 +251781,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -241149,7 +251827,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.10/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.14/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -241434,7 +252112,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -241477,7 +252155,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.10/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.14/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -241797,7 +252475,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -242005,7 +252683,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -242214,7 +252892,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -242347,6 +253025,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -242379,7 +253060,8 @@ "skipped", "stale", "success", - "timed_out" + "timed_out", + "startup_failure" ] }, "created_at": { @@ -242747,6 +253429,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -243225,6 +253910,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -243388,6 +254076,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -243445,7 +254136,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -244671,7 +255362,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -244765,6 +255456,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245119,6 +255813,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245596,6 +256293,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -245807,6 +256507,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -246278,7 +256981,7 @@ "allow_downstream_configuration": true } }, - "authorization-items": { + "classic-personal-access-tokens": { "value": [ { "id": 2, @@ -246359,10 +257062,200 @@ "fingerprint": "jklmnop12345678" } }, + "global-advisory-items": { + "value": [ + { + "id": 1, + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "Heartbleed security advisory", + "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + ] + }, + "global-advisory": { + "value": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + }, "integration": { "value": { "id": 1, "slug": "octoapp", + "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", @@ -246470,7 +257363,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, @@ -246483,7 +257377,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": null } ] }, @@ -246501,6 +257396,7 @@ "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -246973,6 +257869,42 @@ } } }, + "authorization-items": { + "value": [ + { + "id": 2, + "url": "https://enterprise.octocat.com/api/v3/authorizations/2", + "app": { + "name": "My personal access token", + "url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens", + "client_id": "00000000000000000000" + }, + "token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a", + "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45", + "token_last_eight": "Ae178B4a", + "note": "My personal access token", + "note_url": null, + "created_at": "2019-04-24T21:49:02Z", + "updated_at": "2019-04-24T21:49:02Z", + "scopes": [ + "admin:business", + "admin:gpg_key", + "admin:org", + "admin:org_hook", + "admin:pre_receive_hook", + "admin:public_key", + "admin:repo_hook", + "delete_repo", + "gist", + "notifications", + "repo", + "user", + "write:discussion" + ], + "fingerprint": null + } + ] + }, "authorization-response-if-returning-an-existing-token-2": { "value": { "id": 1, @@ -249872,6 +260804,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -250072,6 +261014,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -250316,7 +261268,31 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active" }, { "number": 1, @@ -250401,7 +261377,12 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" } ] }, @@ -250409,6 +261390,8 @@ "value": { "total_advanced_security_committers": 2, "total_count": 2, + "maximum_advanced_security_committers": 4, + "purchased_advanced_security_committers": 4, "repositories": [ { "name": "octocat-org/Hello-World", @@ -250416,11 +261399,13 @@ "advanced_security_committers_breakdown": [ { "user_login": "octocat", - "last_pushed_date": "2021-11-03" + "last_pushed_date": "2021-11-03", + "last_pushed_email": "octocat@github.com" }, { "user_login": "octokitten", - "last_pushed_date": "2021-10-25" + "last_pushed_date": "2021-10-25", + "last_pushed_email": "octokitten@github.com" } ] }, @@ -250430,7 +261415,8 @@ "advanced_security_committers_breakdown": [ { "user_login": "octokitten", - "last_pushed_date": "2021-10-26" + "last_pushed_date": "2021-10-26", + "last_pushed_email": "octokitten@github.com" } ] } @@ -250617,7 +261603,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -250625,7 +261612,6 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", @@ -251513,6 +262499,191 @@ "featured": true } }, + "ghes-get-ssh": { + "value": [ + { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ==", + "fingeprint": "bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45" + }, + { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw==", + "fingeprint": "e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4" + } + ] + }, + "ghes-set-ssh": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "SSH key added successfully", + "modified": true + } + ] + }, + "ghes-delete-ssh": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "SSH key removed successfully" + } + ] + }, + "ghes-checks-system-requirements": { + "value": { + "status": "OK", + "nodes": [ + { + "hostname": "ghe-local-app", + "status": "OK", + "roles_status": [ + { + "status": "OK", + "role": "ConsulServer" + }, + { + "status": "OK", + "role": "JobServer" + }, + { + "status": "OK", + "role": "WebServer" + } + ] + }, + { + "hostname": "ghe-local-app2", + "status": "OK", + "roles_status": [ + { + "status": "OK", + "role": "ConsulServer" + }, + { + "status": "OK", + "role": "GitServer" + } + ] + } + ] + } + }, + "ghes-cluster-status": { + "value": { + "status": "OK", + "nodes": [ + { + "hostname": "ghe-local-app", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "es", + "details": "Elasticsearch cluster is in sync (0 shards initializing, 0 shards unassigned)" + }, + { + "status": "OK", + "name": "git-replication", + "details": "Git replication is in sync" + }, + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + }, + { + "status": "OK", + "name": "memcache", + "details": "" + }, + { + "status": "OK", + "name": "metrics", + "details": "" + }, + { + "status": "OK", + "name": "mysql-replication", + "details": "Replication is running" + }, + { + "status": "OK", + "name": "mysql-failover", + "details": "" + }, + { + "status": "OK", + "name": "pages", + "details": "Pages replication is in sync" + }, + { + "status": "OK", + "name": "redis", + "details": "Redis is OK" + }, + { + "status": "OK", + "name": "storage", + "details": "Storage replication is in sync" + } + ] + }, + { + "hostname": "ghe-local-app2", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + } + ] + } + ] + } + }, + "ghes-license-info": { + "value": [ + { + "advancedSecurityEnabled": true, + "advancedSecuritySeats": 0, + "clusterSupport": false, + "company": "GitHub", + "croquetSupport": true, + "customTerms": true, + "evaluation": false, + "expireAt": "2025-01-02T07:59:59Z", + "insightsEnabled": true, + "insightsExpireAt": "2025-01-02T07:59:59.999Z", + "learningLabEvaluationExpires": "2023-01-02T07:59:59Z", + "learningLabSeats": 100, + "perpetual": false, + "referenceNumber": "32a145", + "seats": 0, + "sshAllowed": true, + "supportKey\"": "", + "unlimitedSeating": true + } + ] + }, + "ghes-license-check": { + "value": [ + { + "status": "valid" + } + ] + }, "ghes-config-nodes": { "value": { "topology": "Cluster", @@ -251539,6 +262710,143 @@ ] } }, + "ghes-get-settings": { + "value": { + "private_mode": false, + "public_pages": false, + "subdomain_isolation": true, + "signup_enabled": false, + "github_hostname": "ghe.local", + "identicons_host": "dotcom", + "http_proxy": null, + "auth_mode": "default", + "expire_sessions": false, + "admin_password": null, + "configuration_id": 1401777404, + "configuration_run_count": 4, + "avatar": { + "enabled": false, + "uri": "" + }, + "customer": { + "name": "GitHub", + "email": "stannis@themannis.biz", + "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9", + "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", + "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n" + }, + "license": { + "seats": 0, + "evaluation": false, + "perpetual": false, + "unlimited_seating": true, + "support_key": "ssh-rsa AAAAB3N....", + "ssh_allowed": true, + "cluster_support": false, + "expire_at": "2016-04-27T00:00:00-07:00" + }, + "github_ssl": { + "enabled": false, + "cert": null, + "key": null + }, + "ldap": { + "host": null, + "port": 0, + "base": [], + "uid": null, + "bind_dn": null, + "password": null, + "method": "Plain", + "search_strategy": "detect", + "user_groups": [], + "admin_group": null, + "virtual_attribute_enabled": false, + "recursive_group_search": false, + "posix_support": true, + "user_sync_emails": false, + "user_sync_keys": false, + "user_sync_interval": 4, + "team_sync_interval": 4, + "sync_enabled": false, + "reconciliation": { + "user": null, + "org": null + }, + "profile": { + "uid": "uid", + "name": null, + "mail": null, + "key": null + } + }, + "cas": { + "url": null + }, + "saml": { + "sso_url": null, + "certificate": null, + "certificate_path": null, + "issuer": null, + "idp_initiated_sso": false, + "disable_admin_demote": false + }, + "github_oauth": { + "client_id": "12313412", + "client_secret": "kj123131132", + "organization_name": "Homestar Runners", + "organization_team": "homestarrunners/characters" + }, + "smtp": { + "enabled": true, + "address": "smtp.example.com", + "authentication": "plain", + "port": "1234", + "domain": "blah", + "username": "foo", + "user_name": "mr_foo", + "enable_starttls_auto": true, + "password": "bar", + "discard-to-noreply-address": true, + "support_address": "enterprise@github.com", + "support_address_type": "email", + "noreply_address": "noreply@github.com" + }, + "ntp": { + "primary_server": "0.pool.ntp.org", + "secondary_server": "1.pool.ntp.org" + }, + "timezone": null, + "snmp": { + "enabled": false, + "community": "" + }, + "syslog": { + "enabled": false, + "server": null, + "protocol_name": "udp" + }, + "assets": null, + "pages": { + "enabled": true + }, + "collectd": { + "enabled": false, + "server": null, + "port": 0, + "encryption": null, + "username": null, + "password": null + }, + "mapping": { + "enabled": true, + "tileserver": null, + "basemap": "company.map-qsz2zrvs", + "token": null + }, + "load_balancer": null + } + }, "ghes-get-maintenance": { "value": [ { @@ -251658,9 +262966,6 @@ "packages": [ "192.0.2.1" ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -251675,7 +262980,7 @@ "*.example.com" ] }, - "installed_version": "3.10.0" + "installed_version": "3.14.0" } }, "public-repo-events-items": { @@ -253079,6 +264384,7 @@ "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, + "client_id": "Iv1.ab1112223334445c", "target_id": 1, "target_type": "Organization", "permissions": { @@ -253829,6 +265135,136 @@ } ] }, + "organization-fine-grained-permission-example": { + "value": [ + { + "name": "read_organization_custom_org_role", + "description": "View organization roles" + }, + { + "name": "write_organization_custom_org_role", + "description": "Manage custom organization roles" + } + ] + }, + "organization-role-list": { + "value": { + "total_count": 2, + "roles": [ + { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + }, + { + "id": 8031, + "name": "Auditor", + "description": "Permissions to read the organization audit log", + "permissions": [ + "read_audit_logs" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + ] + } + }, + "organization-role": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + }, + "team-items": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "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", + "parent": null + } + ] + }, "package-org": { "value": { "id": 197, @@ -253945,6 +265381,8 @@ } }, "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -253986,6 +265424,8 @@ } }, "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", "token_expired": false, "token_expires_at": "2023-11-16T08:47:09.000-07:00", "token_last_used_at": null @@ -254097,6 +265537,97 @@ "updated_at": "2014-03-04T18:58:10Z" } }, + "custom-properties": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "custom-property": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "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" + } + ] + } + }, "full-repository": { "value": { "id": 1296269, @@ -254625,25 +266156,179 @@ } ] }, - "team-items": { + "org-ruleset-items": { "value": [ { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "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", - "parent": null + "id": 21, + "name": "super cool ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + }, + { + "id": 432, + "name": "Another ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/432" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/432" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + ] + }, + "org-ruleset": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + }, + "rule-suite-items": { + "value": [ + { + "id": 21, + "actor_id": 12, + "actor_name": "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, + "actor_name": "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, + "actor_name": "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" + } + ] + } + }, "team-full": { "value": { "id": 1, @@ -255535,6 +267220,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -255780,6 +267471,7 @@ "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, + "allow_forking": true, "subscribers_count": 42, "network_count": 0, "license": { @@ -257107,6 +268799,39 @@ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" } }, + "activity-items": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "before": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "after": "827efc6d56897b048c772eb4087f854f46256132", + "ref": "refs/heads/main", + "pushed_at": "2011-01-26T19:06:43Z", + "push_type": "normal", + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, "autolink-items": { "value": [ { @@ -257173,9 +268898,7 @@ "comment_count": 77, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", @@ -257793,9 +269516,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "comment_count": 0 }, @@ -259255,7 +270976,8 @@ "python" ], "query_suite": "default", - "updated_at": "2023-01-19T11:21:34Z" + "updated_at": "2023-01-19T11:21:34Z", + "schedule": "weekly" } }, "code-scanning-default-setup-update": { @@ -260119,9 +271841,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -260547,9 +272267,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -260625,9 +272343,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -260975,9 +272691,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -261029,16 +272743,13 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } }, "file-commit": { "value": { - "content": null, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -261068,9 +272779,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -261147,6 +272856,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -261280,6 +272999,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -261391,6 +273120,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -261490,6 +273229,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -261649,10 +273398,7 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { "SPDXID": "SPDXRef-Package", @@ -261660,8 +273406,20 @@ "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, - "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseConcluded": "NOASSERTION", + "licenseDeclared": "NOASSERTION" + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -261896,6 +273654,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -261948,7 +273707,7 @@ ], "deployment_branch_policy": { "protected_branches": false, - "custom_branch_policies": true + "custom_branch_policies": "trues" } } ] @@ -261973,6 +273732,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -262060,6 +273820,14 @@ "name": "main" } }, + "deployment-branch-policy-single-tag": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "v1", + "type": "tag" + } + }, "deployment-protection-rules": { "value": [ { @@ -262357,9 +274125,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } @@ -262394,9 +274160,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -262455,9 +274219,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -263840,19 +275602,21 @@ ] }, "deploy-key-items": { - "value": [ - { - "id": 1, - "key": "ssh-rsa AAA...", - "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", - "title": "octocat@octomac", - "verified": true, - "created_at": "2014-12-10T15:53:42Z", - "read_only": true, - "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" - } - ] + "value": { + "enabled": [ + { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z" + } + ] + } }, "deploy-key": { "value": { @@ -264021,6 +275785,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -264108,10 +275874,16 @@ }, "page-deployment": { "value": { - "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251", + "id": "4fd754f7e594640989b406850d0bc8f06a121251", + "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", "page_url": "developer.github.com" } }, + "pages-deployment-status": { + "value": { + "status": "succeed" + } + }, "repository-pre-receive-hook-items": { "value": [ { @@ -264176,6 +275948,40 @@ } ] }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "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", @@ -266648,6 +278454,118 @@ } } }, + "repository-rule-items": { + "value": [ + { + "type": "commit_message_pattern", + "ruleset_source_type": "Repository", + "ruleset_source": "monalisa/my-repo", + "ruleset_id": 42, + "parameters": { + "operator": "starts_with", + "pattern": "issue" + } + }, + { + "type": "commit_author_email_pattern", + "ruleset_source_type": "Organization", + "ruleset_source": "my-org", + "ruleset_id": 73, + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + }, + "repository-ruleset-items": { + "value": [ + { + "id": 42, + "name": "super cool ruleset", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/42" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + }, + { + "id": 314, + "name": "Another ruleset", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/314" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/314" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + ] + }, + "repository-ruleset": { + "value": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/42" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + } + }, "secret-scanning-alert-list": { "value": [ { @@ -266704,7 +278622,31 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "inactive" }, { "number": 1, @@ -266722,7 +278664,12 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" } ] }, @@ -266737,7 +278684,8 @@ "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed": false + "push_protection_bypassed": false, + "validity": "unknown" } }, "secret-scanning-alert-resolved": { @@ -266774,7 +278722,8 @@ "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed": false, - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "unknown" } }, "secret-scanning-location-list": { @@ -266846,7 +278795,7 @@ { "type": "pull_request_title", "details": { - "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, { @@ -267524,7 +279473,7 @@ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "id": "927fa2c08dcb4a7fae9e", + "id": "24b28bbb-5fc4-4686-a153-a020debb1155", "displayName": "Engineering", "members": [ { @@ -267542,7 +279491,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } ], @@ -267574,7 +279523,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } }, @@ -272122,9 +284071,6 @@ "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, "secret_type": "mailchimp_api_key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" }, @@ -272268,7 +284214,7 @@ "parameters": { "per-page": { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272277,7 +284223,7 @@ }, "page": { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272370,6 +284316,33 @@ "type": "integer" } }, + "pagination-before": { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "pagination-after": { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "ghsa_id": { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "cursor": { "name": "cursor", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", @@ -272521,7 +284494,7 @@ }, "audit-log-enterprise-phrase": { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", "in": "query", "required": false, "schema": { @@ -272544,7 +284517,7 @@ }, "audit-log-after": { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", "required": false, "schema": { @@ -272553,7 +284526,7 @@ }, "audit-log-before": { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -272591,24 +284564,6 @@ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" } }, - "pagination-before": { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - "pagination-after": { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -272705,7 +284660,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", + "description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -272734,6 +284689,15 @@ "default": "created" } }, + "secret-scanning-alert-validity": { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, "enterprise-security-product": { "name": "security_product", "in": "path", @@ -272743,6 +284707,7 @@ "type": "string", "enum": [ "advanced_security", + "advanced_security_user_namespace", "dependabot_alerts", "secret_scanning", "secret_scanning_push_protection" @@ -272777,7 +284742,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "labels": { @@ -272789,6 +284755,15 @@ "type": "string" } }, + "license-apply": { + "name": "apply", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, "uuid": { "name": "uuid", "description": "The UUID which identifies a node.", @@ -272857,7 +284832,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -272902,7 +284877,7 @@ }, "variables-per-page": { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -272920,7 +284895,7 @@ }, "audit-log-phrase": { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", "in": "query", "required": false, "schema": { @@ -272945,6 +284920,24 @@ "type": "integer" } }, + "members-per-page": { + "name": "per_page", + "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + "members-page": { + "name": "page", + "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, "migration-id": { "name": "migration_id", "description": "The unique identifier of the migration.", @@ -272963,9 +284956,18 @@ "type": "string" } }, + "team-slug": { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "package-visibility": { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { @@ -273088,29 +285090,104 @@ "type": "integer" } }, - "secret-scanning-pagination-before-org-repo": { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/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.", + "custom-property-name": { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "ruleset-targets": { + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", "in": "query", "required": false, + "schema": { + "type": "string", + "example": "branch,tag,push" + } + }, + "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 + }, + "repository-name-in-query": { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", "schema": { "type": "string" } }, - "secret-scanning-pagination-after-org-repo": { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/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.", + "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" } }, - "team-slug": { - "name": "team_slug", - "description": "The slug of the team name.", + "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-server@3.14/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.14/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-server@3.14/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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-pagination-after-org-repo": { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/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.", + "in": "query", + "required": false, "schema": { "type": "string" } @@ -273298,7 +285375,7 @@ }, "event": { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.10/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.14/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "query", "required": false, "schema": { @@ -273332,7 +285409,7 @@ }, "created": { "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.10/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "query", "required": false, "schema": { @@ -273412,7 +285489,7 @@ }, "branch": { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.10/graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.14/graphql).", "in": "path", "required": true, "schema": { @@ -273622,6 +285699,22 @@ "type": "integer" } }, + "pages-deployment-id": { + "name": "pages_deployment_id", + "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + }, "pull-number": { "name": "pull_number", "description": "The number that identifies the pull request.", @@ -273795,6 +285888,15 @@ "default": "created" } }, + "account-id": { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "since-user": { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.", @@ -273851,22 +285953,22 @@ } }, "responses": { - "not_found": { - "description": "Resource not found", + "validation_failed_simple": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/basic-error" + "$ref": "#/components/schemas/validation-error-simple" } } } }, - "validation_failed_simple": { - "description": "Validation failed, or the endpoint has been spammed.", + "not_found": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/validation-error-simple" + "$ref": "#/components/schemas/basic-error" } } } @@ -274053,16 +286155,6 @@ } } }, - "code_scanning_forbidden_read": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, "forbidden_gist": { "description": "Forbidden Gist", "content": { @@ -274142,6 +286234,16 @@ } } }, + "code_scanning_forbidden_read": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "code_scanning_forbidden_write": { "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", "content": { diff --git a/cache/ghes-3.9.json b/cache/ghes-3.15.json similarity index 89% rename from cache/ghes-3.9.json rename to cache/ghes-3.15.json index 3926bab7e..8e54b1671 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.15.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.6.0", + "version": "17.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": { @@ -14,7 +14,7 @@ "url": "https://github.com/octokit/openapi" }, "x-github-plan": "ghes", - "x-github-release": 3.9 + "x-github-release": 3.15 }, "tags": [ { @@ -152,6 +152,14 @@ { "name": "oauth-authorizations", "description": "OAuth Authorizations API" + }, + { + "name": "security-advisories", + "description": "Security Advisories API" + }, + { + "name": "code-security", + "description": "Endpoints to manage code security using the REST API." } ], "servers": [ @@ -171,7 +179,7 @@ ], "externalDocs": { "description": "GitHub Enterprise Developer Docs", - "url": "https://docs.github.com/enterprise-server@3.9/rest/" + "url": "https://docs.github.com/enterprise-server@3.15/rest/" }, "paths": { "/": { @@ -207,7 +215,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/meta/meta#github-api-root" + "url": "https://docs.github.com/enterprise-server@3.15/rest/meta/meta#github-api-root" }, "x-octokit": {} } @@ -222,7 +230,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#list-global-webhooks" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#list-global-webhooks" }, "parameters": [ { @@ -274,7 +282,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#create-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#create-a-global-webhook" }, "responses": { "201": { @@ -318,7 +326,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers) header." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers) header." }, "insecure_ssl": { "type": "string", @@ -331,7 +339,7 @@ }, "events": { "type": "array", - "description": "The [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "description": "The [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } @@ -385,7 +393,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#get-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#get-a-global-webhook" }, "parameters": [ { @@ -426,7 +434,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#update-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#update-a-global-webhook" }, "parameters": [ { @@ -471,7 +479,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers) header." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers) header." }, "insecure_ssl": { "type": "string", @@ -484,7 +492,7 @@ }, "events": { "type": "array", - "description": "The [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "description": "The [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "items": { "type": "string" } @@ -528,7 +536,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#delete-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#delete-a-global-webhook" }, "parameters": [ { @@ -552,14 +560,14 @@ "/admin/hooks/{hook_id}/pings": { "post": { "summary": "Ping a global webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) to be sent to the webhook.", "operationId": "enterprise-admin/ping-global-webhook", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/global-webhooks#ping-a-global-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#ping-a-global-webhook" }, "parameters": [ { @@ -590,7 +598,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#list-public-keys" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#list-public-keys" }, "parameters": [ { @@ -670,7 +678,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-a-public-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-a-public-key" }, "parameters": [ { @@ -694,14 +702,14 @@ "/admin/ldap/teams/{team_id}/mapping": { "patch": { "summary": "Update LDAP mapping for a team", - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.", "operationId": "enterprise-admin/update-ldap-mapping-for-team", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team" }, "parameters": [ { @@ -770,7 +778,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team" }, "parameters": [ { @@ -820,7 +828,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user" }, "parameters": [ { @@ -889,7 +897,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user" }, "parameters": [ { @@ -939,7 +947,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/orgs#create-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/orgs#create-an-organization" }, "responses": { "201": { @@ -1014,7 +1022,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/orgs#update-an-organization-name" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/orgs#update-an-organization-name" }, "parameters": [ { @@ -1094,7 +1102,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments" }, "parameters": [ { @@ -1158,7 +1166,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment" }, "responses": { "201": { @@ -1228,7 +1236,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment" }, "parameters": [ { @@ -1269,7 +1277,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment" }, "parameters": [ { @@ -1384,7 +1392,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment" }, "parameters": [ { @@ -1461,7 +1469,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download" }, "parameters": [ { @@ -1550,7 +1558,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment" }, "parameters": [ { @@ -1593,7 +1601,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks" }, "parameters": [ { @@ -1658,7 +1666,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook" }, "responses": { "201": { @@ -1758,7 +1766,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook" }, "parameters": [ { @@ -1799,7 +1807,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook" }, "parameters": [ { @@ -1891,7 +1899,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook" }, "parameters": [ { @@ -1922,7 +1930,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#list-personal-access-tokens" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#list-personal-access-tokens" }, "parameters": [ { @@ -1945,7 +1953,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/authorization-items" + "$ref": "#/components/examples/classic-personal-access-tokens" } } } @@ -1976,7 +1984,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-a-personal-access-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-a-personal-access-token" }, "parameters": [ { @@ -2000,14 +2008,14 @@ "/admin/users": { "post": { "summary": "Create a user", - "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", + "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", "operationId": "enterprise-admin/create-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#create-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#create-a-user" }, "responses": { "201": { @@ -2039,7 +2047,7 @@ }, "email": { "type": "string", - "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" + "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"" }, "suspended": { "type": "boolean", @@ -2081,7 +2089,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#update-the-username-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#update-the-username-for-a-user" }, "parameters": [ { @@ -2152,14 +2160,14 @@ }, "delete": { "summary": "Delete a user", - "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", + "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", "operationId": "enterprise-admin/delete-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-a-user" }, "parameters": [ { @@ -2190,7 +2198,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#create-an-impersonation-oauth-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#create-an-impersonation-oauth-token" }, "parameters": [ { @@ -2238,7 +2246,7 @@ "properties": { "scopes": { "type": "array", - "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "items": { "type": "string" } @@ -2277,7 +2285,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#delete-an-impersonation-oauth-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-an-impersonation-oauth-token" }, "parameters": [ { @@ -2298,17 +2306,293 @@ "x-octokit": {} } }, + "/advisories": { + "get": { + "summary": "List global security advisories", + "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.15/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/list-global-advisories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/security-advisories/global-advisories#list-global-security-advisories" + }, + "parameters": [ + { + "name": "ghsa_id", + "in": "query", + "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", + "schema": { + "type": "string", + "enum": [ + "reviewed", + "malware", + "unreviewed" + ], + "default": "reviewed" + } + }, + { + "name": "cve_id", + "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "If specified, only advisories for these ecosystems will be returned.", + "schema": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + } + }, + { + "name": "severity", + "in": "query", + "description": "If specified, only advisories with these severities will be returned.", + "schema": { + "type": "string", + "enum": [ + "unknown", + "low", + "medium", + "high", + "critical" + ] + } + }, + { + "name": "cwes", + "in": "query", + "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 1000, + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "published", + "in": "query", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published", + "epss_percentage", + "epss_percentile" + ], + "default": "published" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/global-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "429": { + "description": "Too many requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + }, + "x-octokit": {} + } + }, + "/advisories/{ghsa_id}": { + "get": { + "summary": "Get a global security advisory", + "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/get-global-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/security-advisories/global-advisories#get-a-global-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/global-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + }, + "x-octokit": {} + } + }, "/app": { "get": { "summary": "Get the authenticated app", - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-the-authenticated-app" }, "parameters": [], "responses": { @@ -2340,14 +2624,14 @@ "/app-manifests/{code}/conversions": { "post": { "summary": "Create a GitHub App from a manifest", - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "tags": [ "apps" ], "operationId": "apps/create-from-manifest", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-a-github-app-from-a-manifest" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-a-github-app-from-a-manifest" }, "parameters": [ { @@ -2423,14 +2707,14 @@ "/app/hook/config": { "get": { "summary": "Get a webhook configuration for an app", - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" }, "responses": { "200": { @@ -2459,14 +2743,14 @@ }, "patch": { "summary": "Update a webhook configuration for an app", - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/update-webhook-config-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" }, "requestBody": { "required": true, @@ -2531,14 +2815,14 @@ "/app/hook/deliveries": { "get": { "summary": "List deliveries for an app webhook", - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/webhooks#list-deliveries-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/webhooks#list-deliveries-for-an-app-webhook" }, "parameters": [ { @@ -2546,14 +2830,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -2594,14 +2870,14 @@ "/app/hook/deliveries/{delivery_id}": { "get": { "summary": "Get a delivery for an app webhook", - "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -2643,14 +2919,14 @@ "/app/hook/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an app webhook", - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" }, "parameters": [ { @@ -2687,7 +2963,7 @@ "operationId": "apps/list-installation-requests-for-authenticated-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installation-requests-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#list-installation-requests-for-the-authenticated-app" }, "parameters": [ { @@ -3507,14 +3783,14 @@ "/app/installations/{installation_id}": { "get": { "summary": "Get an installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -3551,14 +3827,14 @@ }, "delete": { "summary": "Delete an installation for the authenticated app", - "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/delete-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#delete-an-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#delete-an-installation-for-the-authenticated-app" }, "parameters": [ { @@ -3585,14 +3861,14 @@ "/app/installations/{installation_id}/access_tokens": { "post": { "summary": "Create an installation access token for an app", - "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. \n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/create-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-an-installation-access-token-for-an-app" }, "parameters": [ { @@ -3686,14 +3962,14 @@ "/app/installations/{installation_id}/suspended": { "put": { "summary": "Suspend an app installation", - "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/suspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#suspend-an-app-installation" }, "parameters": [ { @@ -3718,14 +3994,14 @@ }, "delete": { "summary": "Unsuspend an app installation", - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/unsuspend-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#unsuspend-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#unsuspend-an-app-installation" }, "parameters": [ { @@ -3752,14 +4028,14 @@ "/applications/grants": { "get": { "summary": "List your grants", - "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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/list-grants", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-grants" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-grants" }, "parameters": [ { @@ -3830,14 +4106,14 @@ "/applications/grants/{grant_id}": { "get": { "summary": "Get a single grant", - "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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-grant", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant" }, "parameters": [ { @@ -3883,14 +4159,14 @@ }, "delete": { "summary": "Delete a grant", - "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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/delete-grant", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#delete-a-grant" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#delete-a-grant" }, "parameters": [ { @@ -3926,14 +4202,14 @@ "/applications/{client_id}/grant": { "delete": { "summary": "Delete an app authorization", - "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "operationId": "apps/delete-authorization", "tags": [ "apps" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/oauth-applications#delete-an-app-authorization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/oauth-applications#delete-an-app-authorization" }, "parameters": [ { @@ -3986,14 +4262,14 @@ "/applications/{client_id}/token": { "post": { "summary": "Check a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/check-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/oauth-applications#check-a-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/oauth-applications#check-a-token" }, "parameters": [ { @@ -4059,14 +4335,14 @@ }, "patch": { "summary": "Reset a token", - "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/reset-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/oauth-applications#reset-a-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/oauth-applications#reset-a-token" }, "parameters": [ { @@ -4129,14 +4405,14 @@ }, "delete": { "summary": "Delete an app token", - "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.", + "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", "tags": [ "apps" ], "operationId": "apps/delete-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/oauth-applications#delete-an-app-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/oauth-applications#delete-an-app-token" }, "parameters": [ { @@ -4189,14 +4465,14 @@ "/applications/{client_id}/token/scoped": { "post": { "summary": "Create a scoped access token", - "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.\n\nYou must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)\nwhen accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App\nas the username and password.", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", "tags": [ "apps" ], "operationId": "apps/scope-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-a-scoped-access-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-a-scoped-access-token" }, "parameters": [ { @@ -4308,14 +4584,14 @@ "/apps/{app_slug}": { "get": { "summary": "Get an app", - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", + "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", "tags": [ "apps" ], "operationId": "apps/get-by-slug", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-an-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app" }, "parameters": [ { @@ -4357,14 +4633,14 @@ "/authorizations": { "get": { "summary": "List your authorizations", - "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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/list-authorizations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations" }, "parameters": [ { @@ -4433,14 +4709,14 @@ }, "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. 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.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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.15/rest/authentication/authenticating-to-the-rest-api#using-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.15/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.15/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.15/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" ], "operationId": "oauth-authorizations/create-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization" }, "parameters": [], "requestBody": { @@ -4559,14 +4835,14 @@ "/authorizations/clients/{client_id}": { "put": { "summary": "Get-or-create an authorization for a specific app", - "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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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\n**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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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 a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-or-create-authorization-for-app", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app" }, "parameters": [ { @@ -4656,7 +4932,7 @@ } }, "201": { - "description": "**Deprecation Notice:** GitHub 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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/).", "content": { "application/json": { "schema": { @@ -4706,14 +4982,14 @@ "/authorizations/clients/{client_id}/{fingerprint}": { "put": { "summary": "Get-or-create an authorization for a specific app and fingerprint", - "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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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).\"", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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]\n> Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" }, "parameters": [ { @@ -4848,14 +5124,14 @@ "/authorizations/{authorization_id}": { "get": { "summary": "Get a single 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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/get-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization" }, "parameters": [ { @@ -4901,14 +5177,14 @@ }, "patch": { "summary": "Update an existing 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\nIf 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\nYou can only send one of these scope keys at a time.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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\nIf 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/update-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization" }, "parameters": [ { @@ -5013,14 +5289,14 @@ }, "delete": { "summary": "Delete an 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/apps/building-oauth-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/).", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/).", "tags": [ "oauth-authorizations" ], "operationId": "oauth-authorizations/delete-authorization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization" }, "parameters": [ { @@ -5063,7 +5339,7 @@ "operationId": "codes-of-conduct/get-all-codes-of-conduct", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" + "url": "https://docs.github.com/enterprise-server@3.15/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" }, "parameters": [], "responses": { @@ -5108,7 +5384,7 @@ "operationId": "codes-of-conduct/get-conduct-code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" + "url": "https://docs.github.com/enterprise-server@3.15/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" }, "parameters": [ { @@ -5162,7 +5438,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/emojis/emojis#get-emojis" + "url": "https://docs.github.com/enterprise-server@3.15/rest/emojis/emojis#get-emojis" }, "parameters": [], "responses": { @@ -5207,7 +5483,7 @@ "operationId": "enterprise-admin/get-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/announcement#get-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/announcement#get-the-global-announcement-banner" }, "responses": { "200": { @@ -5243,7 +5519,7 @@ "operationId": "enterprise-admin/set-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/announcement#set-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/announcement#set-the-global-announcement-banner" }, "requestBody": { "required": true, @@ -5297,7 +5573,7 @@ "operationId": "enterprise-admin/remove-announcement", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/announcement#remove-the-global-announcement-banner" }, "responses": { "204": { @@ -5323,7 +5599,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/license#get-license-information" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/license#get-license-information" }, "responses": { "200": { @@ -5361,7 +5637,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-all-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-all-statistics" }, "responses": { "200": { @@ -5399,7 +5675,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-comment-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-comment-statistics" }, "responses": { "200": { @@ -5442,7 +5718,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-gist-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-gist-statistics" }, "responses": { "200": { @@ -5483,7 +5759,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-hooks-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-hooks-statistics" }, "responses": { "200": { @@ -5525,7 +5801,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-issue-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-issue-statistics" }, "responses": { "200": { @@ -5567,7 +5843,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-milestone-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-milestone-statistics" }, "responses": { "200": { @@ -5609,7 +5885,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-organization-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-organization-statistics" }, "responses": { "200": { @@ -5652,7 +5928,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-pages-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-pages-statistics" }, "responses": { "200": { @@ -5692,7 +5968,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-pull-request-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-pull-request-statistics" }, "responses": { "200": { @@ -5734,7 +6010,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-repository-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-repository-statistics" }, "responses": { "200": { @@ -5769,6 +6045,44 @@ "x-octokit": {} } }, + "/enterprise/stats/security-products": { + "get": { + "summary": "Get security products statistics", + "description": "Gets the statistics about security products for a GitHub Enterprise Server instance.\n\nTo use this endpoint, you must be a site admin.", + "operationId": "enterprise-admin/get-security-products", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-security-products-statistics" + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/enterprise-security-products-overview" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-security-products-overview" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "admin-stats" + }, + "x-octokit": {} + } + }, "/enterprise/stats/users": { "get": { "summary": "Get users statistics", @@ -5779,7 +6093,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/admin-stats#get-users-statistics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-users-statistics" }, "responses": { "200": { @@ -5821,7 +6135,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise" }, "parameters": [ { @@ -5869,7 +6183,7 @@ "operationId": "actions/get-actions-cache-usage-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise" }, "parameters": [ { @@ -5915,7 +6229,7 @@ "operationId": "actions/set-actions-cache-usage-policy-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise" }, "parameters": [ { @@ -5961,7 +6275,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -6002,7 +6316,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise" }, "parameters": [ { @@ -6062,7 +6376,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6124,7 +6438,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6188,7 +6502,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6220,7 +6534,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise" }, "parameters": [ { @@ -6254,7 +6568,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -6295,7 +6609,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise" }, "parameters": [ { @@ -6334,14 +6648,14 @@ "/enterprises/{enterprise}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an enterprise", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -6375,14 +6689,14 @@ }, "put": { "summary": "Set default workflow permissions for an enterprise", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise" }, "parameters": [ { @@ -6428,7 +6742,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise" }, "parameters": [ { @@ -6493,7 +6807,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6614,7 +6928,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6658,7 +6972,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise" }, "parameters": [ { @@ -6754,7 +7068,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise" }, "parameters": [ { @@ -6788,7 +7102,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -6853,7 +7167,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -6920,7 +7234,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -6955,7 +7269,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise" }, "parameters": [ { @@ -6992,7 +7306,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -7062,7 +7376,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise" }, "parameters": [ { @@ -7129,7 +7443,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise" }, "parameters": [ { @@ -7164,7 +7478,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" }, "parameters": [ { @@ -7201,9 +7515,17 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/enterprise" }, @@ -7266,7 +7588,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise" }, "parameters": [ { @@ -7302,6 +7624,97 @@ "x-octokit": {} } }, + "/enterprises/{enterprise}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for an Enterprise", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/generate-runner-jitconfig-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the new runner." + }, + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." + }, + "labels": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" + } + } + }, + "examples": { + "default": { + "value": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + } + } + } + } + } + }, + "responses": { + "201": { + "$ref": "#/components/responses/actions_runner_jitconfig" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, "/enterprises/{enterprise}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for an enterprise", @@ -7312,7 +7725,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise" }, "parameters": [ { @@ -7355,7 +7768,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise" }, "parameters": [ { @@ -7398,7 +7811,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7442,7 +7855,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise" }, "parameters": [ { @@ -7476,7 +7889,7 @@ "operationId": "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7511,7 +7924,7 @@ "operationId": "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7583,7 +7996,7 @@ "operationId": "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7655,7 +8068,7 @@ "operationId": "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7695,7 +8108,7 @@ "operationId": "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise" }, "parameters": [ { @@ -7738,7 +8151,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise" }, "parameters": [ { @@ -7808,14 +8221,14 @@ "/enterprises/{enterprise}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an enterprise", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -7910,14 +8323,14 @@ "/enterprises/{enterprise}/code_security_and_analysis": { "get": { "summary": "Get code security and analysis features for an enterprise", - "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "description": "Gets code security and analysis settings for the specified enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", "tags": [ "enterprise-admin" ], "operationId": "secret-scanning/get-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -7961,7 +8374,7 @@ "operationId": "secret-scanning/patch-security-analysis-settings-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise" }, "parameters": [ { @@ -7977,24 +8390,33 @@ "properties": { "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.9/get-started/learning-about-github/about-github-advanced-security).\"" + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.15/get-started/learning-about-github/about-github-advanced-security).\"" + }, + "advanced_security_enabled_new_user_namespace_repos": { + "type": "boolean", + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.15/get-started/learning-about-github/about-github-advanced-security).\"" }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" + "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"" }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning).\"" + "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning).\"" }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" + "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"" }, "secret_scanning_push_protection_custom_link": { "type": "string", "nullable": true, - "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." + "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`." + }, + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": { + "type": "boolean", + "nullable": true, + "description": "Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise." } } }, @@ -8002,10 +8424,12 @@ "default": { "value": { "advanced_security_enabled_for_new_repositories": true, + "advanced_security_enabled_new_user_namespace_repos": true, "dependabot_alerts_enabled_for_new_repositories": true, "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, - "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md" + "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md", + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": true } } } @@ -8035,14 +8459,14 @@ "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", - "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", + "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" }, "parameters": [ { @@ -8130,14 +8554,14 @@ "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", - "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).", + "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories.", "tags": [ "secret-scanning" ], "operationId": "secret-scanning/list-alerts-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise" }, "parameters": [ { @@ -8166,6 +8590,9 @@ }, { "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -8218,7 +8645,7 @@ "operationId": "billing/get-github-advanced-security-billing-ghe", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise" }, "parameters": [ { @@ -8246,9 +8673,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -8270,7 +8694,7 @@ "operationId": "secret-scanning/post-security-product-enablement-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature" }, "parameters": [ { @@ -8306,14 +8730,14 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-events" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-public-events" }, "parameters": [ { @@ -8364,14 +8788,14 @@ "/feeds": { "get": { "summary": "Get feeds", - "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.15/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ "activity" ], "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/feeds#get-feeds" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/feeds#get-feeds" }, "parameters": [], "responses": { @@ -8410,7 +8834,7 @@ "operationId": "gists/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#list-gists-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#list-gists-for-the-authenticated-user" }, "parameters": [ { @@ -8464,14 +8888,14 @@ }, "post": { "summary": "Create a gist", - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "description": "Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", "operationId": "gists/create", "tags": [ "gists" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#create-a-gist" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#create-a-gist" }, "parameters": [], "requestBody": { @@ -8598,14 +9022,14 @@ "/gists/public": { "get": { "summary": "List public gists", - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "tags": [ "gists" ], "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#list-public-gists" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#list-public-gists" }, "parameters": [ { @@ -8671,7 +9095,7 @@ "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#list-starred-gists" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#list-starred-gists" }, "parameters": [ { @@ -8730,14 +9154,14 @@ "/gists/{gist_id}": { "get": { "summary": "Get a gist", - "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#get-a-gist" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#get-a-gist" }, "parameters": [ { @@ -8913,7 +9337,7 @@ "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#delete-a-gist" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#delete-a-gist" }, "parameters": [ { @@ -8946,14 +9370,14 @@ "/gists/{gist_id}/comments": { "get": { "summary": "List gist comments", - "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/comments#list-gist-comments" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/comments#list-gist-comments" }, "parameters": [ { @@ -9010,14 +9434,14 @@ }, "post": { "summary": "Create a gist comment", - "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/comments#create-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/comments#create-a-gist-comment" }, "parameters": [ { @@ -9099,14 +9523,14 @@ "/gists/{gist_id}/comments/{comment_id}": { "get": { "summary": "Get a gist comment", - "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/comments#get-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/comments#get-a-gist-comment" }, "parameters": [ { @@ -9152,14 +9576,14 @@ }, "patch": { "summary": "Update a gist comment", - "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/comments#update-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/comments#update-a-gist-comment" }, "parameters": [ { @@ -9235,7 +9659,7 @@ "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/comments#delete-a-gist-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/comments#delete-a-gist-comment" }, "parameters": [ { @@ -9278,7 +9702,7 @@ "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#list-gist-commits" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#list-gist-commits" }, "parameters": [ { @@ -9347,7 +9771,7 @@ "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#list-gist-forks" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#list-gist-forks" }, "parameters": [ { @@ -9411,7 +9835,7 @@ "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#fork-a-gist" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#fork-a-gist" }, "parameters": [ { @@ -9474,7 +9898,7 @@ "operationId": "gists/check-is-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#check-if-a-gist-is-starred" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#check-if-a-gist-is-starred" }, "parameters": [ { @@ -9514,14 +9938,14 @@ }, "put": { "summary": "Star a gist", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "gists" ], "operationId": "gists/star", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#star-a-gist" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#star-a-gist" }, "parameters": [ { @@ -9559,7 +9983,7 @@ "operationId": "gists/unstar", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#unstar-a-gist" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#unstar-a-gist" }, "parameters": [ { @@ -9592,14 +10016,14 @@ "/gists/{gist_id}/{sha}": { "get": { "summary": "Get a gist revision", - "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", + "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.", "tags": [ "gists" ], "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#get-a-gist-revision" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#get-a-gist-revision" }, "parameters": [ { @@ -9652,14 +10076,14 @@ "/gitignore/templates": { "get": { "summary": "Get all gitignore templates", - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-the-authenticated-user).", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-for-the-authenticated-user).", "operationId": "gitignore/get-all-templates", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gitignore/gitignore#get-all-gitignore-templates" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gitignore/gitignore#get-all-gitignore-templates" }, "parameters": [], "responses": { @@ -9705,14 +10129,14 @@ "/gitignore/templates/{name}": { "get": { "summary": "Get a gitignore template", - "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", + "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", "operationId": "gitignore/get-template", "tags": [ "gitignore" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gitignore/gitignore#get-a-gitignore-template" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gitignore/gitignore#get-a-gitignore-template" }, "parameters": [ { @@ -9763,7 +10187,7 @@ "operationId": "apps/list-repos-accessible-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/installations#list-repositories-accessible-to-the-app-installation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/installations#list-repositories-accessible-to-the-app-installation" }, "parameters": [ { @@ -9835,14 +10259,14 @@ "/installation/token": { "delete": { "summary": "Revoke an installation access token", - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", "tags": [ "apps" ], "operationId": "apps/revoke-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/installations#revoke-an-installation-access-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/installations#revoke-an-installation-access-token" }, "parameters": [], "responses": { @@ -9862,14 +10286,14 @@ "/issues": { "get": { "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -10014,14 +10438,14 @@ "/licenses": { "get": { "summary": "Get all commonly used licenses", - "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get-all-commonly-used", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/licenses/licenses#get-all-commonly-used-licenses" + "url": "https://docs.github.com/enterprise-server@3.15/rest/licenses/licenses#get-all-commonly-used-licenses" }, "parameters": [ { @@ -10074,14 +10498,14 @@ "/licenses/{license}": { "get": { "summary": "Get a license", - "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", "tags": [ "licenses" ], "operationId": "licenses/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/licenses/licenses#get-a-license" + "url": "https://docs.github.com/enterprise-server@3.15/rest/licenses/licenses#get-a-license" }, "parameters": [ { @@ -10128,17 +10552,17 @@ "x-octokit": {} } }, - "/manage/v1/config/nodes": { + "/manage/v1/access/ssh": { "get": { - "summary": "Get GHES node metadata for all nodes", - "description": "Get node metadata for all configured nodes in the current cluster. For more information, see \"[About clustering](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering).\"", - "operationId": "enterprise-admin/get-config-nodes", + "summary": "Get the configured SSH keys", + "description": "Gets the configured SSH keys on all available nodes. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/get-manage-ssh", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys" }, "servers": [ { @@ -10155,30 +10579,176 @@ } } ], - "parameters": [ + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-get-ssh" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-get-ssh" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "post": { + "summary": "Set a new SSH key", + "description": "Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/set-manage-ssh", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key" + }, + "servers": [ { - "$ref": "#/components/parameters/uuid" + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-ssh-request" + }, + "examples": { + "default": { + "value": { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-ssh-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-set-ssh" + } + } + } + } }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a SSH key", + "description": "Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see \"[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh).\"", + "operationId": "enterprise-admin/delete-manage-ssh", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#delete-a-ssh-key" + }, + "servers": [ { - "$ref": "#/components/parameters/cluster-roles" + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-delete-ssh-request" + }, + "examples": { + "default": { + "value": { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw==" + } + } + } + } + } + }, "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ghes-config-nodes" + "$ref": "#/components/schemas/ghes-delete-ssh-response" }, "examples": { "default": { - "$ref": "#/components/examples/ghes-config-nodes" + "$ref": "#/components/examples/ghes-delete-ssh" } } } } }, + "400": { + "description": "Bad request" + }, "401": { "description": "Unauthorized" }, @@ -10195,17 +10765,1089 @@ "x-octokit": {} } }, - "/manage/v1/replication/status": { + "/manage/v1/checks/system-requirements": { "get": { - "summary": "Get the status of services running on all replica nodes", - "description": "Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply.", - "operationId": "enterprise-admin/get-replication-status", + "summary": "Get the system requirement check results for configured cluster nodes", + "description": "Checks if the minimum requirements for system hardware resources are met on each configured cluster node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-checks-system-requirements", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-system-requirement-check-results-for-configured-cluster-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-checks-system-requirements" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-checks-system-requirements" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/cluster/status": { + "get": { + "summary": "Get the status of services running on all cluster nodes", + "description": "Gets the status of all services running on each cluster node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-cluster-status", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-cluster-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-cluster-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-cluster-status" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/apply": { + "get": { + "summary": "Get the status of a ghe-config-apply run", + "description": "Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID.", + "operationId": "enterprise-admin/get-manage-config-apply-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run" + }, + "parameters": [ + { + "name": "run_id", + "description": "The unique run ID of the `ghe-config-apply` run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running in the environment" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful in the environment" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The unique Run ID of the ghe-config-apply run on the host" + }, + "hostname": { + "type": "string", + "description": "The hostname of the node" + }, + "running": { + "type": "boolean", + "description": "Whether the ghe-config-apply run is still running on the host" + }, + "successful": { + "type": "boolean", + "description": "Whether the ghe-config-apply run was successful on the host" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "running": true, + "successful": false, + "nodes": [ + { + "run_id": "d34db33f", + "hostname": "ghes-01.lan", + "running": true, + "successful": false + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "post": { + "summary": "Trigger a ghe-config-apply run", + "description": "Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance.\nYou can provide a run ID or allow one to be generated randomly.", + "operationId": "enterprise-admin/post-manage-run-config-apply", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run" + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly." + } + } + }, + "examples": { + "default": { + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "run_id": { + "type": "string", + "description": "Run ID the job was launched with" + } + } + }, + "examples": { + "default": { + "value": { + "run_id": "d34db33f" + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/apply/events": { + "get": { + "summary": "List events from ghe-config-apply", + "description": "Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance.", + "operationId": "enterprise-admin/get-manage-config-apply-events", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#list-events-from-ghe-config-apply" + }, + "parameters": [ + { + "name": "last_request_id", + "description": "The unique ID of the last response from a host, used for pagination.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "node": { + "type": "string", + "description": "Hostname of the node" + }, + "last_request_id": { + "type": "string", + "description": "Unique ID of the last response from a host used for pagination" + }, + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "severity_text": { + "type": "string" + }, + "body": { + "type": "string" + }, + "event_name": { + "type": "string" + }, + "topology": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "config_run_id": { + "type": "string" + }, + "trace_id": { + "type": "string" + }, + "span_id": { + "type": "string" + }, + "span_parent_id": { + "type": "string" + }, + "span_depth": { + "type": "integer" + } + } + } + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "nodes": [ + { + "node": "ghes-01.lan", + "last_request_id": "387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000", + "events": [ + { + "timestamp": "2023-01-01T13:00:00+00:00", + "severity_text": "INFO", + "body": "Validating services", + "event_name": "Enterprise::ConfigApply::PhaseValidation#config_phase_validation", + "topology": "multinode", + "hostname": "ghes-01.lan", + "config_run_id": "d34db33f", + "trace_id": "387cd628c06d606700e79be368e5e574", + "span_id": "0cde553750689c76", + "span_parent_id": 0, + "span_depth": 0 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/init": { + "post": { + "summary": "Initialize instance configuration with license and password", + "description": "When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password.\n\n> [!IMPORTANT]\n> To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#start-configuration-apply-process)\n\nThe root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "operationId": "enterprise-admin/initialize-instance-configuration", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ghes-config-init-request" + }, + "examples": { + "default": { + "value": { + "license": "@enterprise.ghl", + "password": "provide-password-here!" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response" + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/license": { + "get": { + "summary": "Get the enterprise license information", + "description": "Gets information about the license that is currently set for the enterprise.", + "operationId": "enterprise-admin/license-info", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-license-info" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-license-info" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "put": { + "summary": "Upload an enterprise license", + "description": "Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter.\n\n> [!NOTE]\n> The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", + "operationId": "enterprise-admin/license-upload", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/license-apply" + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ghes-upload-license-request" + }, + "examples": { + "default": { + "value": { + "license": "@enterprise.ghl" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Created" + }, + "202": { + "description": "Accepted" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/license/check": { + "get": { + "summary": "Check a license", + "description": "Check the status of the license that is currently set for the enterprise.", + "operationId": "enterprise-admin/license-check", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#check-a-license" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-license-check" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-license-check" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/nodes": { + "get": { + "summary": "Get GHES node metadata for all nodes", + "description": "Get node metadata for all configured nodes in the current cluster. For more information, see \"[About clustering](https://docs.github.com/enterprise-server@3.15/admin/enterprise-management/configuring-clustering/about-clustering).\"", + "operationId": "enterprise-admin/get-config-nodes", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/uuid" + }, + { + "$ref": "#/components/parameters/cluster-roles" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-config-nodes" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-config-nodes" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/config/settings": { + "get": { + "summary": "Get the GHES settings", + "description": "Gets a list of settings for a GitHub Enterprise Server instance.", + "operationId": "enterprise-admin/get-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-ghes-settings" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-get-settings" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-get-settings" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "put": { + "summary": "Set settings", + "description": "Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-settings).\n\n**Notes:**\n- The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values.\n- You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", + "operationId": "enterprise-admin/set-manage-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#set-settings" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "description": "Only the settings parameters that should be modified need to be specified.", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": { + "public_pages": true + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/maintenance": { + "get": { + "summary": "Get the status of maintenance mode", + "description": "Gets the status and details of maintenance mode on all available nodes. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", + "operationId": "enterprise-admin/get-manage-maintenance", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/uuid" + }, + { + "$ref": "#/components/parameters/cluster-roles" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-get-maintenance" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-get-maintenance" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + }, + "post": { + "summary": "Set the status of maintenance mode", + "description": "Sets or schedules the maintenance mode. For more information, see \"[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode).\"", + "operationId": "enterprise-admin/set-manage-maintenance", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode" + }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-maintenance-request" + }, + "examples": { + "default": { + "value": { + "enabled": true, + "when": "2006-01-02T15:04:05+00:00", + "ip_exception_list": [ + "192.168.1.0/24", + "1.1.1.1" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ghes-set-maintenance-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ghes-set-maintenance" + } + } + } + } + }, + "400": { + "description": "Bad request" + }, + "401": { + "description": "Unauthorized" + }, + "500": { + "description": "Internal error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-admin", + "subcategory": "manage-ghes" + }, + "x-octokit": {} + } + }, + "/manage/v1/replication/status": { + "get": { + "summary": "Get the status of services running on all replica nodes", + "description": "Gets the status of all services running on each replica node.\nThis endpoint may take several seconds to reply.", + "operationId": "enterprise-admin/get-replication-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes" }, "servers": [ { @@ -10265,14 +11907,14 @@ "/manage/v1/version": { "get": { "summary": "Get all GHES release versions for all nodes", - "description": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.9/admin/all-releases).\"", + "description": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.15/admin/all-releases).\"", "operationId": "enterprise-admin/get-version", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes" }, "servers": [ { @@ -10339,7 +11981,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/markdown/markdown#render-a-markdown-document" + "url": "https://docs.github.com/enterprise-server@3.15/rest/markdown/markdown#render-a-markdown-document" }, "parameters": [], "requestBody": { @@ -10437,7 +12079,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" + "url": "https://docs.github.com/enterprise-server@3.15/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" }, "parameters": [], "requestBody": { @@ -10515,7 +12157,7 @@ "operationId": "meta/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/meta/meta#get-apiname-meta-information" + "url": "https://docs.github.com/enterprise-server@3.15/rest/meta/meta#get-apiname-meta-information" }, "parameters": [], "responses": { @@ -10550,14 +12192,14 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-events-for-repo-network", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-events-for-a-network-of-repositories" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-public-events-for-a-network-of-repositories" }, "parameters": [ { @@ -10624,7 +12266,7 @@ "operationId": "activity/list-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -10644,7 +12286,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -10699,14 +12341,14 @@ }, "put": { "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#mark-notifications-as-read" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#mark-notifications-as-read" }, "parameters": [], "requestBody": { @@ -10791,7 +12433,7 @@ "operationId": "activity/get-thread", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#get-a-thread" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#get-a-thread" }, "parameters": [ { @@ -10841,7 +12483,7 @@ "operationId": "activity/mark-thread-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#mark-a-thread-as-read" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#mark-a-thread-as-read" }, "parameters": [ { @@ -10866,19 +12508,48 @@ "subcategory": "notifications" }, "x-octokit": {} + }, + "delete": { + "summary": "Mark a thread as done", + "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-thread-as-done", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#mark-a-thread-as-done" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "204": { + "description": "No content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + }, + "x-octokit": {} } }, "/notifications/threads/{thread_id}/subscription": { "get": { "summary": "Get a thread subscription for the authenticated user", - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", "tags": [ "activity" ], "operationId": "activity/get-thread-subscription-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" }, "parameters": [ { @@ -10921,14 +12592,14 @@ }, "put": { "summary": "Set a thread subscription", - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription) endpoint.", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#delete-a-thread-subscription) endpoint.", "tags": [ "activity" ], "operationId": "activity/set-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#set-a-thread-subscription" }, "parameters": [ { @@ -10995,14 +12666,14 @@ }, "delete": { "summary": "Delete a thread subscription", - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "tags": [ "activity" ], "operationId": "activity/delete-thread-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#delete-a-thread-subscription" }, "parameters": [ { @@ -11070,7 +12741,7 @@ }, "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/meta/meta#get-octocat" + "url": "https://docs.github.com/enterprise-server@3.15/rest/meta/meta#get-octocat" }, "x-github": { "githubCloudOnly": false, @@ -11084,14 +12755,14 @@ "/organizations": { "get": { "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", "tags": [ "orgs" ], "operationId": "orgs/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#list-organizations" }, "parameters": [ { @@ -11143,15 +12814,15 @@ }, "/organizations/{organization_id}/custom_roles": { "get": { - "summary": "Deprecated - List custom repository roles in an organization", - "description": "**Note**: This operation is deprecated and will be removed in the future.\nUse the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Closing down - List custom repository roles in an organization", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed in the future. Use the \"[List custom repository roles](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)\" endpoint instead.\n\nList the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-custom-roles", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#deprecated---list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization" }, "parameters": [ { @@ -11209,14 +12880,14 @@ "/orgs/{org}": { "get": { "summary": "Get an organization", - "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nThe values returned by this endpoint are set by the \"Update an organization\" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the \"Update an organization\" endpoint have been overwritten by that configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on security configurations, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.15/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission.", "tags": [ "orgs" ], "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#get-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#get-an-organization" }, "parameters": [ { @@ -11253,14 +12924,14 @@ }, "patch": { "summary": "Update an organization", - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nUpdates the organization's profile and member privileges.\n\nWith security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:\n\n- advanced_security_enabled_for_new_repositories\n- dependabot_alerts_enabled_for_new_repositories\n- dependabot_security_updates_enabled_for_new_repositories\n- dependency_graph_enabled_for_new_repositories\n- secret_scanning_enabled_for_new_repositories\n- secret_scanning_push_protection_enabled_for_new_repositories\n\nFor more information on setting a default security configuration, see \"[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version.\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#update-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#update-an-organization" }, "parameters": [ { @@ -11328,19 +12999,19 @@ }, "members_can_create_internal_repositories": { "type": "boolean", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_private_repositories": { "type": "boolean", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_can_create_public_repositories": { "type": "boolean", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." }, "members_allowed_repository_creation_type": { "type": "string", - "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", "enum": [ "all", "private", @@ -11368,27 +13039,33 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot alerts is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether Dependabot security updates is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether dependency graph is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "Whether secret scanning push protection is automatically enabled for new repositories.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -11466,14 +13143,14 @@ }, "delete": { "summary": "Delete an organization", - "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/enterprise-server@3.15/site-policy/github-terms/github-terms-of-service", "operationId": "orgs/delete", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#delete-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#delete-an-organization" }, "parameters": [ { @@ -11510,7 +13187,7 @@ "operationId": "actions/get-actions-cache-usage-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -11558,7 +13235,7 @@ "operationId": "actions/get-actions-cache-usage-by-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" }, "parameters": [ { @@ -11627,7 +13304,7 @@ "operationId": "oidc/get-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -11667,7 +13344,7 @@ "operationId": "oidc/update-oidc-custom-sub-template-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" }, "parameters": [ { @@ -11731,7 +13408,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -11772,7 +13449,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-github-actions-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-github-actions-permissions-for-an-organization" }, "parameters": [ { @@ -11832,7 +13509,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -11894,7 +13571,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -11958,7 +13635,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -11990,7 +13667,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -12024,7 +13701,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -12065,7 +13742,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" }, "parameters": [ { @@ -12104,14 +13781,14 @@ "/orgs/{org}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for an organization", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -12145,14 +13822,14 @@ }, "put": { "summary": "Set default workflow permissions for an organization", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" }, "parameters": [ { @@ -12201,7 +13878,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" }, "parameters": [ { @@ -12251,7 +13928,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12266,7 +13943,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12372,7 +14049,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12389,7 +14066,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12418,7 +14095,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12433,7 +14110,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -12517,7 +14194,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12532,7 +14209,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" }, "parameters": [ { @@ -12549,7 +14226,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12566,7 +14243,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -12616,7 +14293,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12631,7 +14308,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -12681,7 +14358,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12698,7 +14375,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -12718,7 +14395,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12733,7 +14410,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" }, "parameters": [ { @@ -12753,7 +14430,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12770,7 +14447,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -12825,7 +14502,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12840,7 +14517,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" }, "parameters": [ { @@ -12890,7 +14567,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12907,7 +14584,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" }, "parameters": [ { @@ -12927,7 +14604,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12942,7 +14619,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" }, "parameters": [ { @@ -12962,7 +14639,7 @@ }, "x-github": { "enabledForGitHubApps": true, - "githubCloudOnly": true, + "githubCloudOnly": false, "category": "actions", "subcategory": "self-hosted-runner-groups" }, @@ -12979,9 +14656,17 @@ "operationId": "actions/list-self-hosted-runners-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/org" }, @@ -13048,7 +14733,7 @@ "operationId": "actions/list-runner-applications-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" }, "parameters": [ { @@ -13084,6 +14769,97 @@ "x-octokit": {} } }, + "/orgs/{org}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for an organization", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/generate-runner-jitconfig-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the new runner." + }, + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." + }, + "labels": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" + } + } + }, + "examples": { + "default": { + "value": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + } + } + } + } + } + }, + "responses": { + "201": { + "$ref": "#/components/responses/actions_runner_jitconfig" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, "/orgs/{org}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for an organization", @@ -13094,7 +14870,7 @@ "operationId": "actions/create-registration-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" }, "parameters": [ { @@ -13137,7 +14913,7 @@ "operationId": "actions/create-remove-token-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" }, "parameters": [ { @@ -13180,7 +14956,7 @@ "operationId": "actions/get-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13224,7 +15000,7 @@ "operationId": "actions/delete-self-hosted-runner-from-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" }, "parameters": [ { @@ -13258,7 +15034,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13293,7 +15069,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13365,7 +15141,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13437,7 +15213,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13474,7 +15250,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" }, "parameters": [ { @@ -13517,7 +15293,7 @@ "operationId": "actions/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#list-organization-secrets" }, "parameters": [ { @@ -13586,7 +15362,7 @@ "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -13629,7 +15405,7 @@ "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-an-organization-secret" }, "parameters": [ { @@ -13780,7 +15556,7 @@ "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -13814,7 +15590,7 @@ "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -13872,14 +15648,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -13898,7 +15674,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -13937,14 +15713,14 @@ "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -13980,14 +15756,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", "tags": [ "actions" ], "operationId": "actions/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -14032,7 +15808,7 @@ "operationId": "actions/list-org-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-organization-variables" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#list-organization-variables" }, "parameters": [ { @@ -14099,7 +15875,7 @@ "operationId": "actions/create-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#create-an-organization-variable" }, "parameters": [ { @@ -14196,7 +15972,7 @@ "operationId": "actions/get-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#get-an-organization-variable" }, "parameters": [ { @@ -14240,7 +16016,7 @@ "operationId": "actions/update-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#update-an-organization-variable" }, "parameters": [ { @@ -14321,7 +16097,7 @@ "operationId": "actions/delete-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#delete-an-organization-variable" }, "parameters": [ { @@ -14355,7 +16131,7 @@ "operationId": "actions/list-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#list-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -14423,7 +16199,7 @@ "operationId": "actions/set-selected-repos-for-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#set-selected-repositories-for-an-organization-variable" }, "parameters": [ { @@ -14491,7 +16267,7 @@ "operationId": "actions/add-selected-repo-to-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#add-selected-repository-to-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#add-selected-repository-to-an-organization-variable" }, "parameters": [ { @@ -14534,7 +16310,7 @@ "operationId": "actions/remove-selected-repo-from-org-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#remove-selected-repository-from-an-organization-variable" }, "parameters": [ { @@ -14579,7 +16355,7 @@ "operationId": "announcement-banners/get-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/announcement-banners/organizations#get-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/announcement-banners/organizations#get-announcement-banner-for-organization" }, "parameters": [ { @@ -14620,7 +16396,7 @@ "operationId": "announcement-banners/set-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/announcement-banners/organizations#set-announcement-banner-for-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/announcement-banners/organizations#set-announcement-banner-for-organization" }, "requestBody": { "required": true, @@ -14676,7 +16452,7 @@ "operationId": "announcement-banners/remove-announcement-banner-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/announcement-banners/organizations#remove-announcement-banner-from-organization" }, "parameters": [ { @@ -14700,14 +16476,14 @@ "/orgs/{org}/audit-log": { "get": { "summary": "Get the audit log for an organization", - "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", + "description": "Gets the audit log for an organization. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization).\"\n\nBy default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see \"[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).\"\n\nUse pagination to retrieve fewer or more than 30 events. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\"\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint.", "operationId": "orgs/get-audit-log", "tags": [ "orgs" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#get-the-audit-log-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#get-the-audit-log-for-an-organization" }, "parameters": [ { @@ -14767,14 +16543,14 @@ "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", - "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" }, "parameters": [ { @@ -14874,71 +16650,97 @@ "x-octokit": {} } }, - "/orgs/{org}/custom-repository-roles": { + "/orgs/{org}/code-security/configurations": { "get": { - "summary": "List custom repository roles in an organization", - "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\n> [!NOTE]\n> The enablement status will only be returned for installed security products.", "tags": [ - "orgs" + "code-security" ], - "operationId": "orgs/list-custom-repo-roles", + "operationId": "code-security/get-configurations-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#get-code-security-configurations-for-an-organization" }, "parameters": [ { "$ref": "#/components/parameters/org" + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "in": "query", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" } ], "responses": { "200": { - "description": "Response - list of custom role names", + "description": "Response", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of custom roles in this organization", - "example": 3, - "type": "integer" - }, - "custom_roles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/organization-custom-repository-role" - } - } + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration" } }, "examples": { "default": { - "$ref": "#/components/examples/organization-custom-repository-role-list-example" + "$ref": "#/components/examples/code-security-configuration-list" } } } } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-roles" + "category": "code-security", + "subcategory": "configurations" }, "x-octokit": {} }, "post": { - "summary": "Create a custom repository role", - "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\n> [!NOTE]\n> Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.", "tags": [ - "orgs" + "code-security" ], - "operationId": "orgs/create-custom-repo-role", + "operationId": "code-security/create-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#create-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#create-a-code-security-configuration" }, "parameters": [ { @@ -14950,17 +16752,183 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/organization-custom-repository-role-create-schema" + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ], + "default": "disabled" + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph. Dependency Graph is not configurable in GitHub Enterprise Server.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] }, "examples": { "default": { + "summary": "Example for a code security configuration", "value": { - "name": "Labeler", - "description": "A role for issue and pull request labelers", - "base_role": "read", - "permissions": [ - "add_label" - ] + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" } } } @@ -14969,54 +16937,175 @@ }, "responses": { "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\n> [!NOTE]\n> The enablement status will only be returned for installed security products.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#get-default-code-security-configurations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { "description": "Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/organization-custom-repository-role" + "$ref": "#/components/schemas/code-security-default-configurations" }, "examples": { "default": { - "$ref": "#/components/examples/organization-custom-repository-role-example" + "$ref": "#/components/examples/code-security-default-configurations" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/detach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#detach-configurations-from-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to detach from configurations.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + } + }, + "examples": { + "default": { + "summary": "Example for detaching repositories from configurations.", + "value": { + "selected_repository_ids": [ + 32, + 91 + ] } } } } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" }, - "422": { - "$ref": "#/components/responses/validation_failed" + "409": { + "$ref": "#/components/responses/conflict" } }, "x-github": { - "githubCloudOnly": true, + "githubCloudOnly": false, "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "custom-roles" + "category": "code-security", + "subcategory": "configurations" }, "x-octokit": {} } }, - "/orgs/{org}/custom-repository-roles/{role_id}": { + "/orgs/{org}/code-security/configurations/{configuration_id}": { "get": { - "summary": "Get a custom repository role", - "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\n> [!NOTE]\n> The enablement status will only be returned for installed security products.", "tags": [ - "orgs" + "code-security" ], - "operationId": "orgs/get-custom-repo-role", + "operationId": "code-security/get-configuration", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#get-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#get-a-code-security-configuration" }, "parameters": [ { "$ref": "#/components/parameters/org" }, { - "$ref": "#/components/parameters/role-id" + "$ref": "#/components/parameters/configuration-id" } ], "responses": { @@ -15025,18 +17114,612 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/organization-custom-repository-role" + "$ref": "#/components/schemas/code-security-configuration" }, "examples": { "default": { - "$ref": "#/components/examples/organization-custom-repository-role-example" + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\n> [!NOTE]\n> Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph. Dependency Graph is not configurable in GitHub Enterprise Server.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" } } } } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-updated" + } + } + } + } + }, + "204": { + "description": "Response when no new updates are made" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/delete-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#delete-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" }, "404": { "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/attach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#attach-a-configuration-to-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations", + "public", + "private_or_internal", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "selected", + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\n> [!NOTE]\n> The enablement status will only be returned for installed security products.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration-repositories" + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "$ref": "#/components/examples/simple-repository" + } + } + ] + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/custom-repository-roles": { + "get": { + "summary": "List custom repository roles in an organization", + "description": "List the custom repository roles available in this organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-custom-repo-roles", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response - list of custom role names", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of custom roles in this organization", + "example": 3, + "type": "integer" + }, + "custom_roles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-custom-repository-role" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-repository-role-list-example" + } + } + } + } } }, "x-github": { @@ -15047,23 +17730,20 @@ }, "x-octokit": {} }, - "patch": { - "summary": "Update a custom repository role", - "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "post": { + "summary": "Create a custom repository role", + "description": "Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/update-custom-repo-role", + "operationId": "orgs/create-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#update-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#create-a-custom-repository-role" }, "parameters": [ { "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/role-id" } ], "requestBody": { @@ -15071,17 +17751,16 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/organization-custom-repository-role-update-schema" + "$ref": "#/components/schemas/organization-custom-repository-role-create-schema" }, "examples": { "default": { "value": { "name": "Labeler", - "description": "A role for issue and PR labelers", + "description": "A role for issue and pull request labelers", "base_role": "read", "permissions": [ - "add_label", - "remove_label" + "add_label" ] } } @@ -15090,7 +17769,129 @@ } }, "responses": { - "200": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-repository-role" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-repository-role-example" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/custom-repository-roles/{role_id}": { + "get": { + "summary": "Get a custom repository role", + "description": "Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-repo-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#get-a-custom-repository-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-repository-role" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-custom-repository-role-example" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a custom repository role", + "description": "Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-custom-repo-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#update-a-custom-repository-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-repository-role-update-schema" + }, + "examples": { + "default": { + "value": { + "name": "Labeler", + "description": "A role for issue and PR labelers", + "base_role": "read", + "permissions": [ + "add_label", + "remove_label" + ] + } + } + } + } + } + }, + "responses": { + "200": { "description": "Response", "content": { "application/json": { @@ -15122,14 +17923,14 @@ }, "delete": { "summary": "Delete a custom repository role", - "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/delete-custom-repo-role", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#delete-a-custom-repository-role" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#delete-a-custom-repository-role" }, "parameters": [ { @@ -15163,7 +17964,7 @@ "operationId": "dependabot/list-alerts-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" }, "parameters": [ { @@ -15260,7 +18061,7 @@ "operationId": "dependabot/list-org-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#list-organization-secrets" }, "parameters": [ { @@ -15329,7 +18130,7 @@ "operationId": "dependabot/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-an-organization-public-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#get-an-organization-public-key" }, "parameters": [ { @@ -15372,7 +18173,7 @@ "operationId": "dependabot/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#get-an-organization-secret" }, "parameters": [ { @@ -15523,7 +18324,7 @@ "operationId": "dependabot/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#delete-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#delete-an-organization-secret" }, "parameters": [ { @@ -15557,7 +18358,7 @@ "operationId": "dependabot/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -15615,14 +18416,14 @@ }, "put": { "summary": "Set selected repositories for an organization secret", - "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/set-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -15641,7 +18442,7 @@ "properties": { "selected_repository_ids": { "type": "array", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "items": { "type": "integer" } @@ -15680,14 +18481,14 @@ "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { "put": { "summary": "Add selected repository to an organization secret", - "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -15723,14 +18524,14 @@ }, "delete": { "summary": "Remove selected repository from an organization secret", - "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/remove-selected-repo-from-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" }, "parameters": [ { @@ -15775,7 +18576,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" }, "parameters": [ { @@ -15820,14 +18621,14 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-organization-events" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-public-organization-events" }, "parameters": [ { @@ -15872,14 +18673,14 @@ "/orgs/{org}/external-group/{group_id}": { "get": { "summary": "Get an external group", - "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/external-idp-group-info-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#get-an-external-group" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#get-an-external-group" }, "parameters": [ { @@ -15887,6 +18688,12 @@ }, { "$ref": "#/components/parameters/group-id" + }, + { + "$ref": "#/components/parameters/members-per-page" + }, + { + "$ref": "#/components/parameters/members-page" } ], "responses": { @@ -15918,14 +18725,14 @@ "/orgs/{org}/external-groups": { "get": { "summary": "List external groups in an organization", - "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see \"[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89).\"\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-external-idp-groups-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#list-external-groups-in-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#list-external-groups-in-an-organization" }, "parameters": [ { @@ -15988,14 +18795,14 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#list-organization-webhooks" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#list-organization-webhooks" }, "parameters": [ { @@ -16053,7 +18860,7 @@ "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#create-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#create-an-organization-webhook" }, "parameters": [ { @@ -16102,7 +18909,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "default": [ "push" ], @@ -16190,7 +18997,7 @@ "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#get-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#get-an-organization-webhook" }, "parameters": [ { @@ -16237,7 +19044,7 @@ "operationId": "orgs/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#update-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#update-an-organization-webhook" }, "parameters": [ { @@ -16277,7 +19084,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -16342,14 +19149,14 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "You must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#delete-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#delete-an-organization-webhook" }, "parameters": [ { @@ -16386,7 +19193,7 @@ "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -16430,7 +19237,7 @@ "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -16511,7 +19318,7 @@ "operationId": "orgs/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" }, "parameters": [ { @@ -16525,14 +19332,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -16580,7 +19379,7 @@ "operationId": "orgs/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -16635,7 +19434,7 @@ "operationId": "orgs/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" }, "parameters": [ { @@ -16671,14 +19470,14 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], "operationId": "orgs/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#ping-an-organization-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/webhooks#ping-an-organization-webhook" }, "parameters": [ { @@ -16708,14 +19507,14 @@ "/orgs/{org}/installation": { "get": { "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-org-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" }, "parameters": [ { @@ -16758,7 +19557,7 @@ "operationId": "orgs/list-app-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-app-installations-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#list-app-installations-for-an-organization" }, "parameters": [ { @@ -16820,14 +19619,14 @@ "/orgs/{org}/issues": { "get": { "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -16944,7 +19743,7 @@ "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#list-organization-members" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#list-organization-members" }, "parameters": [ { @@ -17033,7 +19832,7 @@ "operationId": "orgs/check-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#check-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#check-organization-membership-for-a-user" }, "parameters": [ { @@ -17079,7 +19878,7 @@ "operationId": "orgs/remove-member", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#remove-an-organization-member" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#remove-an-organization-member" }, "parameters": [ { @@ -17116,7 +19915,7 @@ "operationId": "orgs/get-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#get-organization-membership-for-a-user" }, "parameters": [ { @@ -17159,14 +19958,14 @@ }, "put": { "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.15/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "tags": [ "orgs" ], "operationId": "orgs/set-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#set-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#set-organization-membership-for-a-user" }, "parameters": [ { @@ -17245,7 +20044,7 @@ "operationId": "orgs/remove-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#remove-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#remove-organization-membership-for-a-user" }, "parameters": [ { @@ -17285,7 +20084,7 @@ "operationId": "migrations/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/orgs#list-organization-migrations" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/orgs#list-organization-migrations" }, "parameters": [ { @@ -17349,14 +20148,14 @@ }, "post": { "summary": "Start an organization migration", - "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).\"", + "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.15/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" ], "operationId": "migrations/start-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/orgs#start-an-organization-migration" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/orgs#start-an-organization-migration" }, "parameters": [ { @@ -17487,7 +20286,7 @@ "operationId": "migrations/get-status-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/orgs#get-an-organization-migration-status" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/orgs#get-an-organization-migration-status" }, "parameters": [ { @@ -17552,7 +20351,7 @@ "operationId": "migrations/download-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/orgs#download-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/orgs#download-an-organization-migration-archive" }, "parameters": [ { @@ -17587,7 +20386,7 @@ "operationId": "migrations/delete-archive-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/orgs#delete-an-organization-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/orgs#delete-an-organization-migration-archive" }, "parameters": [ { @@ -17617,14 +20416,14 @@ "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { "delete": { "summary": "Unlock an organization repository", - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", "tags": [ "migrations" ], "operationId": "migrations/unlock-repo-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/orgs#unlock-an-organization-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/orgs#unlock-an-organization-repository" }, "parameters": [ { @@ -17664,7 +20463,7 @@ "operationId": "migrations/list-repos-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/orgs#list-repositories-in-an-organization-migration" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/orgs#list-repositories-in-an-organization-migration" }, "parameters": [ { @@ -17717,6 +20516,758 @@ "x-octokit": {} } }, + "/orgs/{org}/organization-fine-grained-permissions": { + "get": { + "summary": "List organization fine-grained permissions for an organization", + "description": "Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo list the fine-grained permissions that can be used in custom repository roles for an organization, see \"[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-organization-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-fine-grained-permission" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-fine-grained-permission-example" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles": { + "get": { + "summary": "Get all organization roles for an organization", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-roles", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response - list of organization roles", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of organization roles available to the organization." + }, + "roles": { + "type": "array", + "description": "The list of organization roles available to the organization.", + "items": { + "$ref": "#/components/schemas/organization-role" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-role-list" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a custom organization role", + "description": "Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo include repository permissions in an organization role, you must also include the `base_role`\nfield, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.\n\nSee \"[List repository permissions](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)\" for valid repository permissions.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-custom-organization-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#create-a-custom-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-organization-role-create-schema" + }, + "examples": { + "default": { + "value": { + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-role" + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:19:11Z" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}": { + "delete": { + "summary": "Remove all organization roles for a team", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + "put": { + "summary": "Assign an organization role to a team", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-team-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, team or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled for the organization, or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove an organization role from a team", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/users/{username}": { + "delete": { + "summary": "Remove all organization roles for a user", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + "put": { + "summary": "Assign an organization role to a user", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-user-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#assign-an-organization-role-to-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, user or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove an organization role from a user", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#remove-an-organization-role-from-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/{role_id}": { + "get": { + "summary": "Get an organization role", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#get-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-role" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-role" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Update a custom organization role", + "description": "Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nIf the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either\npreviously or as part of the update.\nIf the update sets the `base_role` field to `none`, you must also remove all of the repository\npermissions as well, otherwise the update will fail.\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/patch-custom-organization-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#update-a-custom-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-organization-role-update-schema" + }, + "examples": { + "default": { + "value": { + "description": "Permissions to manage custom roles within an org." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-role" + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:19:11Z" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a custom organization role.", + "description": "Deletes a custom organization role. For more information on custom organization roles, see \"[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-custom-organization-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#delete-a-custom-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/{role_id}/teams": { + "get": { + "summary": "List teams that are assigned to an organization role", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response - List of assigned teams", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of teams assigned to the organization role", + "items": { + "$ref": "#/components/schemas/team-role-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/organization-roles/{role_id}/users": { + "get": { + "summary": "List users that are assigned to an organization role", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response - List of assigned users", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of users assigned to the organization role", + "items": { + "$ref": "#/components/schemas/user-role-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + }, + "x-octokit": {} + } + }, "/orgs/{org}/outside_collaborators": { "get": { "summary": "List outside collaborators for an organization", @@ -17727,7 +21278,7 @@ "operationId": "orgs/list-outside-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" }, "parameters": [ { @@ -17791,14 +21342,14 @@ "/orgs/{org}/outside_collaborators/{username}": { "put": { "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.9/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.15/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "tags": [ "orgs" ], "operationId": "orgs/convert-member-to-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" }, "parameters": [ { @@ -17859,7 +21410,7 @@ "description": "User was converted" }, "403": { - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" }, "404": { "$ref": "#/components/responses/not_found" @@ -17882,7 +21433,7 @@ "operationId": "orgs/remove-outside-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" }, "parameters": [ { @@ -17915,7 +21466,7 @@ "response-if-user-is-a-member-of-the-organization": { "value": { "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + "documentation_url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" } } } @@ -17935,14 +21486,14 @@ "/orgs/{org}/packages": { "get": { "summary": "List packages for an organization", - "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-packages-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#list-packages-for-an-organization" }, "parameters": [ { @@ -17970,7 +21521,7 @@ }, { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -17979,7 +21530,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -18028,14 +21579,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for an organization", - "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-a-package-for-an-organization" }, "parameters": [ { @@ -18075,14 +21626,14 @@ }, "delete": { "summary": "Delete a package for an organization", - "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#delete-a-package-for-an-organization" }, "parameters": [ { @@ -18121,14 +21672,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for an organization", - "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-a-package-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#restore-a-package-for-an-organization" }, "parameters": [ { @@ -18176,14 +21727,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by an organization", - "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ { @@ -18267,14 +21818,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for an organization", - "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-organization", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-a-package-version-for-an-organization" }, "parameters": [ { @@ -18317,14 +21868,14 @@ }, "delete": { "summary": "Delete package version for an organization", - "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#delete-package-version-for-an-organization" }, "parameters": [ { @@ -18366,14 +21917,14 @@ "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for an organization", - "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-package-version-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#restore-package-version-for-an-organization" }, "parameters": [ { @@ -18412,6 +21963,680 @@ "x-octokit": {} } }, + "/orgs/{org}/personal-access-token-requests": { + "get": { + "summary": "List requests to access organization resources with fine-grained personal access tokens", + "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/personal-access-token-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/personal-access-token-owner" + }, + { + "$ref": "#/components/parameters/personal-access-token-repository" + }, + { + "$ref": "#/components/parameters/personal-access-token-permission" + }, + { + "$ref": "#/components/parameters/personal-access-token-before" + }, + { + "$ref": "#/components/parameters/personal-access-token-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-programmatic-access-grant-request" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-pat-grant-request-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + }, + "post": { + "summary": "Review requests to access organization resources with fine-grained personal access tokens", + "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/review-pat-grant-requests-in-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pat_request_ids": { + "type": "array", + "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.", + "items": { + "type": "integer" + }, + "minItems": 1, + "maxItems": 100 + }, + "action": { + "type": "string", + "description": "Action to apply to the requests.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": "string", + "description": "Reason for approving or denying the requests. Max 1024 characters.", + "maxLength": 1024, + "nullable": true + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "pat_request_ids": [ + 42, + 73 + ], + "action": "deny", + "reason": "Access is too broad." + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + "post": { + "summary": "Review a request to access organization resources with a fine-grained personal access token", + "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/review-pat-grant-request", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the request.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": "string", + "description": "Reason for approving or denying the request. Max 1024 characters.", + "maxLength": 1024, + "nullable": true + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "action": "deny", + "reason": "This request is denied because the access is too broad." + } + } + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + "get": { + "summary": "List repositories requested to be accessed by a fine-grained personal access token", + "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-request-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/personal-access-tokens": { + "get": { + "summary": "List fine-grained personal access tokens with access to organization resources", + "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grants", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/personal-access-token-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/personal-access-token-owner" + }, + { + "$ref": "#/components/parameters/personal-access-token-repository" + }, + { + "$ref": "#/components/parameters/personal-access-token-permission" + }, + { + "$ref": "#/components/parameters/personal-access-token-before" + }, + { + "$ref": "#/components/parameters/personal-access-token-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-programmatic-access-grant" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-pat-grant-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + }, + "post": { + "summary": "Update the access to organization resources via fine-grained personal access tokens", + "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-accesses", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + }, + "pat_ids": { + "description": "The IDs of the fine-grained personal access tokens.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token." + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "action", + "pat_ids" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke", + "pat_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}": { + "post": { + "summary": "Update the access a fine-grained personal access token has to organization resources", + "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-access", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/fine-grained-personal-access-token-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke" + } + } + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + "get": { + "summary": "List repositories a fine-grained personal access token has access to", + "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pat_id", + "in": "path", + "description": "Unique identifier of the fine-grained personal access token.", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + }, + "x-octokit": {} + } + }, "/orgs/{org}/pre-receive-hooks": { "get": { "summary": "List pre-receive hooks for an organization", @@ -18422,7 +22647,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization" }, "parameters": [ { @@ -18492,7 +22717,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization" }, "parameters": [ { @@ -18536,7 +22761,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization" }, "parameters": [ { @@ -18608,7 +22833,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization" }, "parameters": [ { @@ -18654,7 +22879,7 @@ "operationId": "projects/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#list-organization-projects" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#list-organization-projects" }, "parameters": [ { @@ -18727,7 +22952,7 @@ "operationId": "projects/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#create-an-organization-project" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#create-an-organization-project" }, "parameters": [ { @@ -18806,6 +23031,472 @@ "x-octokit": {} } }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-all-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-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/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-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/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" + ], + "values_editable_by": "org_actors" + }, + { + "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/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-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/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-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.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-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": { + "$ref": "#/components/schemas/custom-property-set-payload" + }, + "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/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-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": "custom-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-server@3.15/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "repository_query", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.15/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "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": "custom-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\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-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": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + }, + "x-octokit": {} + } + }, "/orgs/{org}/public_members": { "get": { "summary": "List public organization members", @@ -18816,7 +23507,7 @@ "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#list-public-organization-members" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#list-public-organization-members" }, "parameters": [ { @@ -18873,7 +23564,7 @@ "operationId": "orgs/check-public-membership-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#check-public-organization-membership-for-a-user" }, "parameters": [ { @@ -18901,14 +23592,14 @@ }, "put": { "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "orgs" ], "operationId": "orgs/set-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -18943,7 +23634,7 @@ "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -18970,14 +23661,14 @@ "/orgs/{org}/repos": { "get": { "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-organization-repositories" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-organization-repositories" }, "parameters": [ { @@ -19079,7 +23770,7 @@ "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-an-organization-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-an-organization-repository" }, "parameters": [ { @@ -19112,7 +23803,7 @@ }, "visibility": { "type": "string", - "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.9/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.15/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -19160,7 +23851,7 @@ }, "license_template": { "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.9/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.15/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." }, "allow_squash_merge": { "type": "boolean", @@ -19189,7 +23880,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -19199,7 +23890,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -19216,7 +23907,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -19226,6 +23917,11 @@ "BLANK" ], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "custom_properties": { + "type": "object", + "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -19291,14 +23987,14 @@ "/orgs/{org}/repository-fine-grained-permissions": { "get": { "summary": "List repository fine-grained permissions for an organization", - "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "description": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"\n\nThe authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/list-repo-fine-grained-permissions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization" }, "parameters": [ { @@ -19334,48 +24030,36 @@ "x-octokit": {} } }, - "/orgs/{org}/secret-scanning/alerts": { + "/orgs/{org}/rulesets": { "get": { - "summary": "List secret scanning alerts for an organization", - "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "summary": "Get all organization repository rulesets", + "description": "Get all the repository rulesets for an organization.", "tags": [ - "secret-scanning" + "repos" ], - "operationId": "secret-scanning/list-alerts-for-org", + "operationId": "repos/get-org-rulesets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/rules#get-all-organization-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { "$ref": "#/components/parameters/org" }, - { - "$ref": "#/components/parameters/secret-scanning-alert-state" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - }, - { - "$ref": "#/components/parameters/secret-scanning-alert-sort" - }, - { - "$ref": "#/components/parameters/direction" - }, - { - "$ref": "#/components/parameters/page" - }, { "$ref": "#/components/parameters/per-page" }, { - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" + "$ref": "#/components/parameters/page" }, { - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + "$ref": "#/components/parameters/ruleset-targets" } ], "responses": { @@ -19386,73 +24070,673 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/organization-secret-scanning-alert" + "$ref": "#/components/schemas/repository-ruleset" } }, "examples": { "default": { - "$ref": "#/components/examples/organization-secret-scanning-alert-list" + "$ref": "#/components/examples/org-ruleset-items" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, "404": { "$ref": "#/components/responses/not_found" }, - "503": { - "$ref": "#/components/responses/service_unavailable" + "500": { + "$ref": "#/components/responses/internal_error" } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "secret-scanning", - "subcategory": "secret-scanning" - }, "x-octokit": {} - } - }, - "/orgs/{org}/security-managers": { - "get": { - "summary": "List security manager teams", - "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + }, + "post": { + "summary": "Create an organization repository ruleset", + "description": "Create a repository ruleset for an organization.", "tags": [ - "orgs" + "repos" ], - "operationId": "orgs/list-security-manager-teams", + "operationId": "repos/create-org-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/security-managers#list-security-manager-teams" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/rules#create-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" }, "parameters": [ { "$ref": "#/components/parameters/org" } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-simple" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-items" - } - } - } - } + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset.", + "enum": [ + "branch", + "tag", + "push" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/org-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "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-server@3.15/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-server@3.15/rest/orgs/rule-suites#list-organization-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/ref-in-query" + }, + { + "$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-server@3.15/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-server@3.15/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", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/rules#get-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "put": { + "summary": "Update an organization repository ruleset", + "description": "Update a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/update-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/rules#update-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset.", + "enum": [ + "branch", + "tag", + "push" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/org-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete an organization repository ruleset", + "description": "Delete a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/rules#delete-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + } + }, + "/orgs/{org}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for an organization", + "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-secret-type" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-resolution" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-secret-scanning-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-secret-scanning-alert-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/security-managers": { + "get": { + "summary": "List security manager teams", + "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-security-manager-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/security-managers#list-security-manager-teams" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + } } }, "x-github": { @@ -19468,14 +24752,14 @@ "/orgs/{org}/security-managers/teams/{team_slug}": { "put": { "summary": "Add a security manager team", - "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/add-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/security-managers#add-a-security-manager-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/security-managers#add-a-security-manager-team" }, "parameters": [ { @@ -19488,9 +24772,6 @@ "responses": { "204": { "description": "Response" - }, - "409": { - "description": "The organization has reached the maximum number of security manager teams." } }, "x-github": { @@ -19504,14 +24785,14 @@ }, "delete": { "summary": "Remove a security manager team", - "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/remove-security-manager-team", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/security-managers#remove-a-security-manager-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/security-managers#remove-a-security-manager-team" }, "parameters": [ { @@ -19546,7 +24827,7 @@ "operationId": "billing/get-github-advanced-security-billing-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization" }, "parameters": [ { @@ -19574,9 +24855,6 @@ } } } - }, - "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" } }, "x-github": { @@ -19598,7 +24876,7 @@ "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-teams" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-teams" }, "parameters": [ { @@ -19649,14 +24927,14 @@ }, "post": { "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.9/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.15/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#create-a-team" }, "parameters": [ { @@ -19700,9 +24978,17 @@ "closed" ] }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push" @@ -19715,7 +25001,7 @@ }, "ldap_dn": { "type": "string", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"" + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"" } }, "required": [ @@ -19728,6 +25014,7 @@ "name": "Justice League", "description": "A great team", "permission": "push", + "notification_setting": "notifications_enabled", "privacy": "closed" } } @@ -19770,14 +25057,14 @@ "/orgs/{org}/teams/{team_slug}": { "get": { "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-by-name" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#get-a-team-by-name" }, "parameters": [ { @@ -19817,14 +25104,14 @@ }, "patch": { "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#update-a-team" }, "parameters": [ { @@ -19857,9 +25144,17 @@ "closed" ] }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -19879,7 +25174,8 @@ "value": { "name": "new team name", "description": "new team description", - "privacy": "closed" + "privacy": "closed", + "notification_setting": "notifications_enabled" } } } @@ -19937,14 +25233,14 @@ }, "delete": { "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], "operationId": "teams/delete-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#delete-a-team" }, "parameters": [ { @@ -19971,14 +25267,14 @@ "/orgs/{org}/teams/{team_slug}/discussions": { "get": { "summary": "List discussions", - "description": "List all discussions on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all discussions on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions" }, "parameters": [ { @@ -20041,14 +25337,14 @@ }, "post": { "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#create-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion" }, "parameters": [ { @@ -20125,14 +25421,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific discussion on a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion" }, "parameters": [ { @@ -20172,14 +25468,14 @@ }, "patch": { "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#update-a-discussion" }, "parameters": [ { @@ -20246,14 +25542,14 @@ }, "delete": { "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Delete a discussion from a team's page.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion" }, "parameters": [ { @@ -20283,14 +25579,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments", - "description": "List all comments on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List all comments on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussion-comments-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments" }, "parameters": [ { @@ -20347,14 +25643,14 @@ }, "post": { "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Creates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment" }, "parameters": [ { @@ -20423,14 +25719,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "Get a specific comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment" }, "parameters": [ { @@ -20473,14 +25769,14 @@ }, "patch": { "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Edits the body text of a discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment" }, "parameters": [ { @@ -20549,14 +25845,14 @@ }, "delete": { "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Deletes a comment on a team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment" }, "parameters": [ { @@ -20589,14 +25885,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment" }, "parameters": [ { @@ -20613,7 +25909,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", "required": false, "schema": { @@ -20672,14 +25968,14 @@ }, "post": { "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment" }, "parameters": [ { @@ -20704,7 +26000,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "enum": [ "+1", "-1", @@ -20775,14 +26071,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/delete-for-team-discussion-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-team-discussion-comment-reaction" }, "parameters": [ { @@ -20818,14 +26114,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion).\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion" }, "parameters": [ { @@ -20839,7 +26135,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "query", "required": false, "schema": { @@ -20898,14 +26194,14 @@ }, "post": { "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion" }, "parameters": [ { @@ -20927,7 +26223,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ "+1", "-1", @@ -20998,14 +26294,14 @@ "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!NOTE]\n> You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/delete-for-team-discussion", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#delete-team-discussion-reaction" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-team-discussion-reaction" }, "parameters": [ { @@ -21038,14 +26334,14 @@ "/orgs/{org}/teams/{team_slug}/external-groups": { "get": { "summary": "List a connection between an external group and a team", - "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Lists a connection between a team and an external group.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/list-linked-external-idp-groups-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -21082,14 +26378,14 @@ }, "patch": { "summary": "Update the connection between an external group and a team", - "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", + "description": "Creates a connection between a team and an external group. Only one external group can be linked to a team.\n\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)\" in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/link-external-idp-group-to-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -21153,14 +26449,14 @@ }, "delete": { "summary": "Remove the connection between an external group and a team", - "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Deletes a connection between a team and an external group.\n\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "teams" ], "operationId": "teams/unlink-external-idp-group-from-team-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team" }, "parameters": [ { @@ -21194,7 +26490,7 @@ "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#list-team-members" }, "parameters": [ { @@ -21262,14 +26558,14 @@ "/orgs/{org}/teams/{team_slug}/memberships/{username}": { "get": { "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team).", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user" }, "parameters": [ { @@ -21312,14 +26608,14 @@ }, "put": { "summary": "Add or update team membership for a user", - "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user" }, "parameters": [ { @@ -21394,14 +26690,14 @@ }, "delete": { "summary": "Remove team membership for a user", - "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user" }, "parameters": [ { @@ -21434,14 +26730,14 @@ "/orgs/{org}/teams/{team_slug}/projects": { "get": { "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "description": "Lists the organization projects for a team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "tags": [ "teams" ], "operationId": "teams/list-projects-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects" }, "parameters": [ { @@ -21494,14 +26790,14 @@ "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project" }, "parameters": [ { @@ -21544,14 +26840,14 @@ }, "put": { "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/add-or-update-project-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions" }, "parameters": [ { @@ -21573,7 +26869,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "enum": [ "read", "write", @@ -21617,7 +26913,7 @@ "response-if-the-project-is-not-owned-by-the-organization": { "value": { "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions" + "documentation_url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions" } } } @@ -21635,14 +26931,14 @@ }, "delete": { "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], "operationId": "teams/remove-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team" }, "parameters": [ { @@ -21672,14 +26968,14 @@ "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -21732,14 +27028,14 @@ "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-repository" }, "parameters": [ { @@ -21788,14 +27084,14 @@ }, "put": { "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-repository-permissions" }, "parameters": [ { @@ -21820,8 +27116,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "default": "push" + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." } } }, @@ -21851,14 +27146,14 @@ }, "delete": { "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-repository-from-a-team" }, "parameters": [ { @@ -21891,14 +27186,14 @@ "/orgs/{org}/teams/{team_slug}/teams": { "get": { "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-child-teams" }, "parameters": [ { @@ -21951,14 +27246,14 @@ "/orgs/{org}/{security_product}/{enablement}": { "post": { "summary": "Enable or disable a security feature for an organization", - "description": "Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", "tags": [ "orgs" ], "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" }, "parameters": [ { @@ -21971,6 +27266,30 @@ "$ref": "#/components/parameters/org-security-product-enablement" } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" + ] + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, "responses": { "204": { "description": "Action started" @@ -21984,8 +27303,11 @@ "enabledForGitHubApps": true, "previews": [], "category": "orgs", - "subcategory": "orgs" + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" }, + "deprecated": true, "x-octokit": {} } }, @@ -21999,7 +27321,7 @@ "operationId": "projects/get-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/cards#get-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/cards#get-a-project-card" }, "parameters": [ { @@ -22052,7 +27374,7 @@ "operationId": "projects/update-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/cards#update-an-existing-project-card" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/cards#update-an-existing-project-card" }, "parameters": [ { @@ -22139,7 +27461,7 @@ "operationId": "projects/delete-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/cards#delete-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/cards#delete-a-project-card" }, "parameters": [ { @@ -22203,7 +27525,7 @@ "operationId": "projects/move-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/cards#move-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/cards#move-a-project-card" }, "parameters": [ { @@ -22365,7 +27687,7 @@ "operationId": "projects/get-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/columns#get-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/columns#get-a-project-column" }, "parameters": [ { @@ -22418,7 +27740,7 @@ "operationId": "projects/update-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/columns#update-an-existing-project-column" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/columns#update-an-existing-project-column" }, "parameters": [ { @@ -22496,7 +27818,7 @@ "operationId": "projects/delete-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/columns#delete-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/columns#delete-a-project-column" }, "parameters": [ { @@ -22536,7 +27858,7 @@ "operationId": "projects/list-cards", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/cards#list-project-cards" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/cards#list-project-cards" }, "parameters": [ { @@ -22615,7 +27937,7 @@ "operationId": "projects/create-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/cards#create-a-project-card" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/cards#create-a-project-card" }, "parameters": [ { @@ -22771,7 +28093,7 @@ "operationId": "projects/move-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/columns#move-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/columns#move-a-project-column" }, "parameters": [ { @@ -22857,7 +28179,7 @@ "operationId": "projects/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#get-a-project" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#get-a-project" }, "parameters": [ { @@ -22907,7 +28229,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#update-a-project" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#update-a-project" }, "parameters": [ { @@ -23039,7 +28361,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#delete-a-project" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#delete-a-project" }, "parameters": [ { @@ -23106,7 +28428,7 @@ "operationId": "projects/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/collaborators#list-project-collaborators" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#list-project-collaborators" }, "parameters": [ { @@ -23193,7 +28515,7 @@ "operationId": "projects/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/collaborators#add-project-collaborator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#add-project-collaborator" }, "parameters": [ { @@ -23272,7 +28594,7 @@ "operationId": "projects/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/collaborators#remove-user-as-a-collaborator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#remove-user-as-a-collaborator" }, "parameters": [ { @@ -23321,7 +28643,7 @@ "operationId": "projects/get-permission-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/collaborators#get-project-permission-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#get-project-permission-for-a-user" }, "parameters": [ { @@ -23382,7 +28704,7 @@ "operationId": "projects/list-columns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/columns#list-project-columns" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/columns#list-project-columns" }, "parameters": [ { @@ -23446,7 +28768,7 @@ "operationId": "projects/create-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/columns#create-a-project-column" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/columns#create-a-project-column" }, "parameters": [ { @@ -23530,14 +28852,14 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.9/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.9/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.9/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.9/rest/overview/api-versions).\"\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.15/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.15/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.15/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.15/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.15/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/enterprise-server@3.15/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, "parameters": [], "responses": { @@ -23586,14 +28908,14 @@ "/repos/{owner}/{repo}": { "get": { "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "tags": [ "repos" ], "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository" }, "parameters": [ { @@ -23639,14 +28961,14 @@ }, "patch": { "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics) endpoint.", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#replace-all-repository-topics) endpoint.", "tags": [ "repos" ], "operationId": "repos/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#update-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#update-a-repository" }, "parameters": [ { @@ -23677,7 +28999,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.15/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -23691,7 +29013,7 @@ }, "security_and_analysis": { "type": "object", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "nullable": true, "properties": { "advanced_security": { @@ -23723,6 +29045,16 @@ "description": "Can be `enabled` or `disabled`." } } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } } } }, @@ -23777,7 +29109,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -23787,7 +29119,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -23804,7 +29136,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -23886,12 +29218,12 @@ { "required": false, "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.9/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.15/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" }, { "required": false, "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -23906,7 +29238,7 @@ "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#delete-a-repository" }, "parameters": [ { @@ -23942,7 +29274,7 @@ "default": { "value": { "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository" + "documentation_url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#delete-a-repository" } } } @@ -23972,7 +29304,7 @@ "operationId": "actions/list-artifacts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#list-artifacts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/artifacts#list-artifacts-for-a-repository" }, "parameters": [ { @@ -24047,7 +29379,7 @@ "operationId": "actions/get-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#get-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/artifacts#get-an-artifact" }, "parameters": [ { @@ -24094,7 +29426,7 @@ "operationId": "actions/delete-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#delete-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/artifacts#delete-an-artifact" }, "parameters": [ { @@ -24131,7 +29463,7 @@ "operationId": "actions/download-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#download-an-artifact" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/artifacts#download-an-artifact" }, "parameters": [ { @@ -24184,7 +29516,7 @@ "operationId": "actions/get-actions-cache-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" }, "parameters": [ { @@ -24230,7 +29562,7 @@ "operationId": "actions/get-actions-cache-usage-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-policy-for-a-repository" }, "parameters": [ { @@ -24274,7 +29606,7 @@ "operationId": "actions/set-actions-cache-usage-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository" }, "parameters": [ { @@ -24323,7 +29655,7 @@ "operationId": "actions/get-actions-cache-list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#list-github-actions-caches-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#list-github-actions-caches-for-a-repository" }, "parameters": [ { @@ -24391,7 +29723,7 @@ "operationId": "actions/delete-actions-cache-by-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" }, "parameters": [ { @@ -24443,7 +29775,7 @@ "operationId": "actions/delete-actions-cache-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" }, "parameters": [ { @@ -24480,7 +29812,7 @@ "operationId": "actions/get-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" }, "parameters": [ { @@ -24529,7 +29861,7 @@ "operationId": "actions/download-job-logs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" }, "parameters": [ { @@ -24574,7 +29906,7 @@ "operationId": "actions/re-run-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" }, "parameters": [ { @@ -24649,7 +29981,7 @@ "operationId": "actions/get-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -24699,7 +30031,7 @@ "operationId": "actions/set-custom-oidc-sub-claim-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" }, "parameters": [ { @@ -24793,7 +30125,7 @@ "operationId": "actions/list-repo-organization-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-repository-organization-secrets" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#list-repository-organization-secrets" }, "parameters": [ { @@ -24865,7 +30197,7 @@ "operationId": "actions/list-repo-organization-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-repository-organization-variables" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#list-repository-organization-variables" }, "parameters": [ { @@ -24937,7 +30269,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -24991,7 +30323,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-github-actions-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-github-actions-permissions-for-a-repository" }, "parameters": [ { @@ -25047,14 +30379,14 @@ "/repos/{owner}/{repo}/actions/permissions/access": { "get": { "summary": "Get the level of access for workflows outside of the repository", - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -25092,14 +30424,14 @@ }, "put": { "summary": "Set the level of access for workflows outside of the repository", - "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\" and\n\"[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-workflow-access-to-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" }, "parameters": [ { @@ -25149,7 +30481,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -25193,7 +30525,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" }, "parameters": [ { @@ -25235,14 +30567,14 @@ "/repos/{owner}/{repo}/actions/permissions/workflow": { "get": { "summary": "Get default workflow permissions for a repository", - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/get-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -25279,14 +30611,14 @@ }, "put": { "summary": "Set default workflow permissions for a repository", - "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/set-github-actions-default-workflow-permissions-repository", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" }, "parameters": [ { @@ -25338,9 +30670,17 @@ "operationId": "actions/list-self-hosted-runners-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" }, "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/owner" }, @@ -25410,7 +30750,7 @@ "operationId": "actions/list-runner-applications-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" }, "parameters": [ { @@ -25449,6 +30789,100 @@ "x-octokit": {} } }, + "/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\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/generate-runner-jitconfig-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the new runner." + }, + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." + }, + "labels": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" + } + } + }, + "examples": { + "default": { + "value": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + } + } + } + } + } + }, + "responses": { + "201": { + "$ref": "#/components/responses/actions_runner_jitconfig" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", @@ -25459,7 +30893,7 @@ "operationId": "actions/create-registration-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" }, "parameters": [ { @@ -25505,7 +30939,7 @@ "operationId": "actions/create-remove-token-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" }, "parameters": [ { @@ -25551,7 +30985,7 @@ "operationId": "actions/get-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -25598,7 +31032,7 @@ "operationId": "actions/delete-self-hosted-runner-from-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" }, "parameters": [ { @@ -25635,7 +31069,7 @@ "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -25673,7 +31107,7 @@ "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -25748,7 +31182,7 @@ "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -25823,7 +31257,7 @@ "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -25863,7 +31297,7 @@ "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" }, "parameters": [ { @@ -25902,14 +31336,14 @@ "/repos/{owner}/{repo}/actions/runs": { "get": { "summary": "List workflow runs for a repository", - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" }, "parameters": [ { @@ -26005,7 +31439,7 @@ "operationId": "actions/get-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#get-a-workflow-run" }, "parameters": [ { @@ -26055,7 +31489,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#delete-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#delete-a-workflow-run" }, "parameters": [ { @@ -26092,7 +31526,7 @@ "operationId": "actions/get-reviews-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" }, "parameters": [ { @@ -26144,7 +31578,7 @@ "operationId": "actions/list-workflow-run-artifacts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/artifacts#list-workflow-run-artifacts" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/artifacts#list-workflow-run-artifacts" }, "parameters": [ { @@ -26222,7 +31656,7 @@ "operationId": "actions/get-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#get-a-workflow-run-attempt" }, "parameters": [ { @@ -26270,14 +31704,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { "get": { "summary": "List jobs for a workflow run attempt", - "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run-attempt", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" }, "parameters": [ { @@ -26358,7 +31792,7 @@ "operationId": "actions/download-workflow-run-attempt-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#download-workflow-run-attempt-logs" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#download-workflow-run-attempt-logs" }, "parameters": [ { @@ -26406,7 +31840,123 @@ "operationId": "actions/cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#cancel-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#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}/deployment_protection_rule": { + "post": { + "summary": "Review custom deployment protection rules for a workflow run", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/review-custom-gates-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/review-custom-gates-comment-required" + }, + { + "$ref": "#/components/schemas/review-custom-gates-state-required" + } + ] + }, + "examples": { + "default": { + "value": { + "environment_name": "prod-eus", + "state": "approved", + "comment": "All health checks passed." + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "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\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/force-cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#force-cancel-a-workflow-run" }, "parameters": [ { @@ -26451,14 +32001,14 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { "get": { "summary": "List jobs for a workflow run", - "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "actions" ], "operationId": "actions/list-jobs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" }, "parameters": [ { @@ -26547,7 +32097,7 @@ "operationId": "actions/download-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#download-workflow-run-logs" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#download-workflow-run-logs" }, "parameters": [ { @@ -26590,7 +32140,7 @@ "operationId": "actions/delete-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#delete-workflow-run-logs" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#delete-workflow-run-logs" }, "parameters": [ { @@ -26633,7 +32183,7 @@ "operationId": "actions/get-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -26683,7 +32233,7 @@ "operationId": "actions/review-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" }, "parameters": [ { @@ -26789,7 +32339,7 @@ "operationId": "actions/re-run-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#re-run-a-workflow" }, "parameters": [ { @@ -26861,7 +32411,7 @@ "operationId": "actions/re-run-workflow-failed-jobs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" }, "parameters": [ { @@ -26933,7 +32483,7 @@ "operationId": "actions/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#list-repository-secrets" }, "parameters": [ { @@ -27005,7 +32555,7 @@ "operationId": "actions/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -27051,7 +32601,7 @@ "operationId": "actions/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-a-repository-secret" }, "parameters": [ { @@ -27091,14 +32641,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -27120,7 +32670,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -27177,7 +32727,7 @@ "operationId": "actions/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -27214,7 +32764,7 @@ "operationId": "actions/list-repo-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-repository-variables" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#list-repository-variables" }, "parameters": [ { @@ -27284,7 +32834,7 @@ "operationId": "actions/create-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#create-a-repository-variable" }, "parameters": [ { @@ -27362,7 +32912,7 @@ "operationId": "actions/get-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#get-a-repository-variable" }, "parameters": [ { @@ -27409,7 +32959,7 @@ "operationId": "actions/update-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#update-a-repository-variable" }, "parameters": [ { @@ -27472,7 +33022,7 @@ "operationId": "actions/delete-repo-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-a-repository-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#delete-a-repository-variable" }, "parameters": [ { @@ -27509,7 +33059,7 @@ "operationId": "actions/list-repo-workflows", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#list-repository-workflows" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflows#list-repository-workflows" }, "parameters": [ { @@ -27581,7 +33131,7 @@ "operationId": "actions/get-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#get-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflows#get-a-workflow" }, "parameters": [ { @@ -27630,7 +33180,7 @@ "operationId": "actions/disable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#disable-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflows#disable-a-workflow" }, "parameters": [ { @@ -27667,7 +33217,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#create-a-workflow-dispatch-event" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflows#create-a-workflow-dispatch-event" }, "parameters": [ { @@ -27740,7 +33290,7 @@ "operationId": "actions/enable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflows#enable-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflows#enable-a-workflow" }, "parameters": [ { @@ -27770,14 +33320,14 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs for a workflow", - "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", "tags": [ "actions" ], "operationId": "actions/list-workflow-runs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" }, "parameters": [ { @@ -27866,17 +33416,137 @@ "x-octokit": {} } }, + "/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 activity and data for your repository](https://docs.github.com/enterprise-server@3.15/repositories/viewing-activity-and-data-for-your-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/list-activities", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-activities" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "ref", + "description": "The Git reference for the activities you want to list.\n\nThe `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "actor", + "description": "The GitHub username to use to filter by the actor who performed the activity.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "day", + "week", + "month", + "quarter", + "year" + ] + } + }, + { + "name": "activity_type", + "description": "The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "push", + "force_push", + "branch_creation", + "branch_deletion", + "pr_merge", + "merge_queue_merge" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/activity" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/activity-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/assignees": { "get": { "summary": "List assignees", - "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.9/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.15/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "tags": [ "issues" ], "operationId": "issues/list-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#list-assignees" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/assignees#list-assignees" }, "parameters": [ { @@ -27939,7 +33609,7 @@ "operationId": "issues/check-user-can-be-assigned", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#check-if-a-user-can-be-assigned" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/assignees#check-if-a-user-can-be-assigned" }, "parameters": [ { @@ -27991,7 +33661,7 @@ "operationId": "repos/list-autolinks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/autolinks#get-all-autolinks-of-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/autolinks#get-all-autolinks-of-a-repository" }, "parameters": [ { @@ -28038,7 +33708,7 @@ "operationId": "repos/create-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" }, "parameters": [ { @@ -28133,7 +33803,7 @@ "operationId": "repos/get-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" }, "parameters": [ { @@ -28183,7 +33853,7 @@ "operationId": "repos/delete-autolink", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" }, "parameters": [ { @@ -28213,6 +33883,58 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/automated-security-fixes": { + "get": { + "summary": "Check if automated security fixes are enabled for a repository", + "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.15/articles/configuring-automated-security-fixes)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-automated-security-fixes", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response if Dependabot is enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-automated-security-fixes" + }, + "examples": { + "default": { + "value": { + "enabled": true, + "paused": false + } + } + } + } + } + }, + "404": { + "description": "Not Found if Dependabot is not enabled for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/branches": { "get": { "summary": "List branches", @@ -28223,7 +33945,7 @@ "operationId": "repos/list-branches", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branches#list-branches" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branches#list-branches" }, "parameters": [ { @@ -28234,7 +33956,7 @@ }, { "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "description": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "query", "required": false, "schema": { @@ -28295,7 +34017,7 @@ "operationId": "repos/get-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branches#get-a-branch" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branches#get-a-branch" }, "parameters": [ { @@ -28343,14 +34065,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection": { "get": { "summary": "Get branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-branch-protection" }, "parameters": [ { @@ -28393,14 +34115,14 @@ }, "put": { "summary": "Update branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", "tags": [ "repos" ], "operationId": "repos/update-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#update-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#update-branch-protection" }, "parameters": [ { @@ -28432,7 +34154,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -28506,7 +34228,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.9/articles/about-code-owners/) review them." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.15/articles/about-code-owners/) review them." }, "required_approving_review_count": { "type": "integer", @@ -28580,16 +34302,16 @@ }, "required_linear_history": { "type": "boolean", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." }, "allow_force_pushes": { "type": "boolean", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "nullable": true }, "allow_deletions": { "type": "boolean", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." }, "block_creations": { "type": "boolean", @@ -28709,14 +34431,14 @@ }, "delete": { "summary": "Delete branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#delete-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#delete-branch-protection" }, "parameters": [ { @@ -28749,14 +34471,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { "get": { "summary": "Get admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-admin-branch-protection" }, "parameters": [ { @@ -28796,14 +34518,14 @@ }, "post": { "summary": "Set admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/set-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#set-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#set-admin-branch-protection" }, "parameters": [ { @@ -28843,14 +34565,14 @@ }, "delete": { "summary": "Delete admin branch protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/delete-admin-branch-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#delete-admin-branch-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#delete-admin-branch-protection" }, "parameters": [ { @@ -28883,14 +34605,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { "get": { "summary": "Get pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-pull-request-review-protection" }, "parameters": [ { @@ -28930,14 +34652,14 @@ }, "patch": { "summary": "Update pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", "tags": [ "repos" ], "operationId": "repos/update-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#update-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#update-pull-request-review-protection" }, "parameters": [ { @@ -28990,7 +34712,7 @@ }, "require_code_owner_reviews": { "type": "boolean", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.9/articles/about-code-owners/) have reviewed." + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.15/articles/about-code-owners/) have reviewed." }, "required_approving_review_count": { "type": "integer", @@ -29095,14 +34817,14 @@ }, "delete": { "summary": "Delete pull request review protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/delete-pull-request-review-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#delete-pull-request-review-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#delete-pull-request-review-protection" }, "parameters": [ { @@ -29135,14 +34857,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "get": { "summary": "Get commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.9/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.15/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/get-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-commit-signature-protection" }, "parameters": [ { @@ -29185,14 +34907,14 @@ }, "post": { "summary": "Create commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/create-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#create-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#create-commit-signature-protection" }, "parameters": [ { @@ -29235,14 +34957,14 @@ }, "delete": { "summary": "Delete commit signature protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", "tags": [ "repos" ], "operationId": "repos/delete-commit-signature-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#delete-commit-signature-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#delete-commit-signature-protection" }, "parameters": [ { @@ -29275,14 +34997,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { "get": { "summary": "Get status checks protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-status-checks-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-status-checks-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-status-checks-protection" }, "parameters": [ { @@ -29325,14 +35047,14 @@ }, "patch": { "summary": "Update status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", "tags": [ "repos" ], "operationId": "repos/update-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#update-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#update-status-check-protection" }, "parameters": [ { @@ -29359,7 +35081,7 @@ "contexts": { "type": "array", "deprecated": true, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "items": { "type": "string" } @@ -29442,14 +35164,14 @@ }, "delete": { "summary": "Remove status check protection", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#remove-status-check-protection" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#remove-status-check-protection" }, "parameters": [ { @@ -29479,14 +35201,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { "get": { "summary": "Get all status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/get-all-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-all-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-all-status-check-contexts" }, "parameters": [ { @@ -29534,14 +35256,14 @@ }, "post": { "summary": "Add status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/add-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#add-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#add-status-check-contexts" }, "parameters": [ { @@ -29639,14 +35361,14 @@ }, "put": { "summary": "Set status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/set-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#set-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#set-status-check-contexts" }, "parameters": [ { @@ -29739,14 +35461,14 @@ }, "delete": { "summary": "Remove status check contexts", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "tags": [ "repos" ], "operationId": "repos/remove-status-check-contexts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#remove-status-check-contexts" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#remove-status-check-contexts" }, "parameters": [ { @@ -29840,14 +35562,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "get": { "summary": "Get access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "tags": [ "repos" ], "operationId": "repos/get-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-access-restrictions" }, "parameters": [ { @@ -29890,14 +35612,14 @@ }, "delete": { "summary": "Delete access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "tags": [ "repos" ], "operationId": "repos/delete-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#delete-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#delete-access-restrictions" }, "parameters": [ { @@ -29927,14 +35649,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { "get": { "summary": "Get apps with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/get-apps-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" }, "parameters": [ { @@ -29980,14 +35702,14 @@ }, "post": { "summary": "Add app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/add-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#add-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#add-app-access-restrictions" }, "parameters": [ { @@ -30001,32 +35723,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -30074,14 +35792,14 @@ }, "put": { "summary": "Set app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/set-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#set-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#set-app-access-restrictions" }, "parameters": [ { @@ -30095,32 +35813,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -30168,14 +35882,14 @@ }, "delete": { "summary": "Remove app access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", "tags": [ "repos" ], "operationId": "repos/remove-app-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#remove-app-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#remove-app-access-restrictions" }, "parameters": [ { @@ -30189,31 +35903,28 @@ } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "apps": { - "type": "array", - "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "apps" - ], - "example": { - "apps": [ - "my-app" - ] + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" } } - ] + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } }, "examples": { "default": { @@ -30263,14 +35974,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { "get": { "summary": "Get teams with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "tags": [ "repos" ], "operationId": "repos/get-teams-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" }, "parameters": [ { @@ -30316,14 +36027,14 @@ }, "post": { "summary": "Add team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", "tags": [ "repos" ], "operationId": "repos/add-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#add-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#add-team-access-restrictions" }, "parameters": [ { @@ -30411,14 +36122,14 @@ }, "put": { "summary": "Set team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", "tags": [ "repos" ], "operationId": "repos/set-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#set-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#set-team-access-restrictions" }, "parameters": [ { @@ -30506,14 +36217,14 @@ }, "delete": { "summary": "Remove team access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", "tags": [ "repos" ], "operationId": "repos/remove-team-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#remove-team-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#remove-team-access-restrictions" }, "parameters": [ { @@ -30602,14 +36313,14 @@ "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { "get": { "summary": "Get users with access to the protected branch", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "tags": [ "repos" ], "operationId": "repos/get-users-with-access-to-protected-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" }, "parameters": [ { @@ -30655,14 +36366,14 @@ }, "post": { "summary": "Add user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/add-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#add-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#add-user-access-restrictions" }, "parameters": [ { @@ -30676,32 +36387,28 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } }, "examples": { "default": { @@ -30750,14 +36457,14 @@ }, "put": { "summary": "Set user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "tags": [ "repos" ], "operationId": "repos/set-user-access-restrictions", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#set-user-access-restrictions" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#set-user-access-restrictions" }, "parameters": [ { @@ -30771,130 +36478,123 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" } } - ] - }, - "examples": { - "default": { - "summary": "Example replacing a user in a branch protection rule", - "value": { - "users": [ - "octocat" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } }, - "examples": { - "default": { - "$ref": "#/components/examples/simple-user-items" - } + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] } - } - } - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "requestBodyParameterName": "users", - "category": "branches", - "subcategory": "branch-protection" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Remove user access restrictions", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "tags": [ - "repos" - ], - "operationId": "repos/remove-user-access-restrictions", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#remove-user-access-restrictions" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/branch" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "users": { - "type": "array", - "description": "The username for users", - "items": { - "type": "string" - } - } - }, - "required": [ - "users" - ], - "example": { - "users": [ - "mona" - ] - } - } - ] }, "examples": { "default": { - "summary": "Example removing a user in a branch protection rule", + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "users", + "category": "branches", + "subcategory": "branch-protection" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove user access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/remove-user-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection#remove-user-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" + } + } + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", "value": { "users": [ "octocat" @@ -30941,14 +36641,14 @@ "/repos/{owner}/{repo}/branches/{branch}/rename": { "post": { "summary": "Rename a branch", - "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", "tags": [ "repos" ], "operationId": "repos/rename-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branches#rename-a-branch" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branches#rename-a-branch" }, "parameters": [ { @@ -31343,14 +37043,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}": { "get": { "summary": "Get a check run", - "description": "Gets a single check run using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/runs#get-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/runs#get-a-check-run" }, "parameters": [ { @@ -31390,14 +37090,14 @@ }, "patch": { "summary": "Update a check run", - "description": "Updates a check run for a specific commit in a 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/runs#update-a-check-run" }, "parameters": [ { @@ -31485,7 +37185,7 @@ }, "annotations": { "type": "array", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.9/articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.15/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.15/articles/about-status-checks#checks)\".", "maxItems": 50, "items": { "type": "object", @@ -31573,7 +37273,7 @@ }, "actions": { "type": "array", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.15/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "maxItems": 3, "items": { "type": "object", @@ -31710,7 +37410,7 @@ "operationId": "checks/list-annotations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/runs#list-check-run-annotations" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/runs#list-check-run-annotations" }, "parameters": [ { @@ -31766,14 +37466,14 @@ "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { "post": { "summary": "Rerequest a check run", - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/rerequest-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/runs#rerequest-a-check-run" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/runs#rerequest-a-check-run" }, "parameters": [ { @@ -31838,14 +37538,14 @@ "/repos/{owner}/{repo}/check-suites": { "post": { "summary": "Create a check suite", - "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n**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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.15/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> 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\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/create-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/suites#create-a-check-suite" }, "parameters": [ { @@ -31925,14 +37625,14 @@ "/repos/{owner}/{repo}/check-suites/preferences": { "patch": { "summary": "Update repository preferences for check suites", - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", "tags": [ "checks" ], "operationId": "checks/set-suites-preferences", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/suites#update-repository-preferences-for-check-suites" }, "parameters": [ { @@ -32017,14 +37717,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { "get": { "summary": "Get a check suite", - "description": "Gets a single check suite using its `id`.\n\n**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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/get-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/suites#get-a-check-suite" }, "parameters": [ { @@ -32066,14 +37766,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "Lists check runs for a check suite using its `id`.\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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> 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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/runs#list-check-runs-in-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/runs#list-check-runs-in-a-check-suite" }, "parameters": [ { @@ -32161,14 +37861,14 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { "post": { "summary": "Rerequest a check suite", - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", "tags": [ "checks" ], "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/suites#rerequest-a-check-suite" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/suites#rerequest-a-check-suite" }, "parameters": [ { @@ -32210,14 +37910,14 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists code scanning alerts.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "tags": [ "code-scanning" ], "operationId": "code-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -32246,14 +37946,13 @@ }, { "name": "sort", - "description": "The property by which to sort the results. . `number` is deprecated - we recommend that you use `created` instead.", + "description": "The property by which to sort the results.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "number", "updated" ], "default": "created" @@ -32261,11 +37960,20 @@ }, { "name": "state", - "description": "Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "description": "If specified, only code scanning alerts with this state will be returned.", "in": "query", "required": false, "schema": { - "$ref": "#/components/schemas/code-scanning-alert-state" + "$ref": "#/components/schemas/code-scanning-alert-state-query" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-severity" } } ], @@ -32305,7 +38013,7 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "code-scanning", - "subcategory": null + "subcategory": "code-scanning" }, "x-octokit": {} } @@ -32320,7 +38028,7 @@ "operationId": "code-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#get-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#get-a-code-scanning-alert" }, "parameters": [ { @@ -32390,7 +38098,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#update-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#update-a-code-scanning-alert" }, "parameters": [ { @@ -32481,7 +38189,7 @@ "operationId": "code-scanning/list-alert-instances", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" }, "parameters": [ { @@ -32554,14 +38262,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses": { "get": { "summary": "List code scanning analyses for a repository", - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/list-recent-analyses", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" }, "parameters": [ { @@ -32658,14 +38366,14 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" }, "parameters": [ { @@ -32738,7 +38446,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" }, "parameters": [ { @@ -32815,7 +38523,7 @@ "operationId": "code-scanning/get-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -32868,7 +38576,7 @@ "operationId": "code-scanning/update-default-setup", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" }, "parameters": [ { @@ -32949,14 +38657,14 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" }, "parameters": [ { @@ -33068,7 +38776,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" }, "parameters": [ { @@ -33122,17 +38830,75 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/code-security-configuration": { + "get": { + "summary": "Get the code security configuration associated with a repository", + "description": "Get the code security configuration that manages a repository's code security settings.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configuration-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-for-repository" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/codeowners/errors": { "get": { "summary": "List CODEOWNERS errors", - "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", + "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", "tags": [ "repos" ], "operationId": "repos/codeowners-errors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-codeowners-errors" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-codeowners-errors" }, "parameters": [ { @@ -33191,7 +38957,7 @@ "operationId": "repos/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators#list-repository-collaborators" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators#list-repository-collaborators" }, "parameters": [ { @@ -33285,7 +39051,7 @@ "operationId": "repos/check-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" }, "parameters": [ { @@ -33316,14 +39082,14 @@ }, "put": { "summary": "Add a repository collaborator", - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", + "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.", "tags": [ "repos" ], "operationId": "repos/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators#add-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators#add-a-repository-collaborator" }, "parameters": [ { @@ -33383,14 +39149,14 @@ }, "delete": { "summary": "Remove a repository collaborator", - "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n**Note**: A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations\n- Unasigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", "tags": [ "repos" ], "operationId": "repos/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators#remove-a-repository-collaborator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators#remove-a-repository-collaborator" }, "parameters": [ { @@ -33433,7 +39199,7 @@ "operationId": "repos/get-collaborator-permission-level", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators#get-repository-permissions-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators#get-repository-permissions-for-a-user" }, "parameters": [ { @@ -33478,14 +39244,14 @@ "/repos/{owner}/{repo}/comments": { "get": { "summary": "List commit comments for a repository", - "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-commit-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/comments#list-commit-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/comments#list-commit-comments-for-a-repository" }, "parameters": [ { @@ -33538,14 +39304,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}": { "get": { "summary": "Get a commit comment", - "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/get-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment" }, "parameters": [ { @@ -33588,14 +39354,14 @@ }, "patch": { "summary": "Update a commit comment", - "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/update-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/comments#update-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/comments#update-a-commit-comment" }, "parameters": [ { @@ -33671,7 +39437,7 @@ "operationId": "repos/delete-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/comments#delete-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/comments#delete-a-commit-comment" }, "parameters": [ { @@ -33704,14 +39470,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a commit comment", - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment).", + "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-commit-comment" }, "parameters": [ { @@ -33725,7 +39491,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", "in": "query", "required": false, "schema": { @@ -33787,14 +39553,14 @@ }, "post": { "summary": "Create reaction for a commit comment", - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", + "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-commit-comment" }, "parameters": [ { @@ -33816,7 +39582,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the commit comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the commit comment.", "enum": [ "+1", "-1", @@ -33890,14 +39656,14 @@ "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a commit comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#delete-a-commit-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-a-commit-comment-reaction" }, "parameters": [ { @@ -33930,14 +39696,14 @@ "/repos/{owner}/{repo}/commits": { "get": { "summary": "List commits", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-commits" }, "parameters": [ { @@ -33983,11 +39749,18 @@ } }, { - "$ref": "#/components/parameters/since" + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } }, { "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", "in": "query", "required": false, "schema": { @@ -34051,14 +39824,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { "get": { "summary": "List branches for HEAD commit", - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "tags": [ "repos" ], "operationId": "repos/list-branches-for-head-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-branches-for-head-commit" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-branches-for-head-commit" }, "parameters": [ { @@ -34109,14 +39882,14 @@ "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { "get": { "summary": "List commit comments", - "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/list-comments-for-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/comments#list-commit-comments" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/comments#list-commit-comments" }, "parameters": [ { @@ -34170,14 +39943,14 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], "operationId": "repos/create-commit-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/comments#create-a-commit-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/comments#create-a-commit-comment" }, "parameters": [ { @@ -34211,7 +39984,7 @@ }, "line": { "type": "integer", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." + "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." } }, "required": [ @@ -34282,7 +40055,7 @@ "operationId": "repos/list-pull-requests-associated-with-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-pull-requests-associated-with-a-commit" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-pull-requests-associated-with-a-commit" }, "parameters": [ { @@ -34341,14 +40114,14 @@ "/repos/{owner}/{repo}/commits/{ref}": { "get": { "summary": "Get a commit", - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/commits#get-a-commit" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/commits#get-a-commit" }, "parameters": [ { @@ -34411,14 +40184,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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.15/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.15/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/runs#list-check-runs-for-a-git-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/runs#list-check-runs-for-a-git-reference" }, "parameters": [ { @@ -34514,14 +40287,14 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", "tags": [ "checks" ], "operationId": "checks/list-suites-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/checks/suites#list-check-suites-for-a-git-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/checks/suites#list-check-suites-for-a-git-reference" }, "parameters": [ { @@ -34609,7 +40382,7 @@ "operationId": "repos/get-combined-status-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" }, "parameters": [ { @@ -34667,7 +40440,7 @@ "operationId": "repos/list-commit-statuses-for-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/statuses#list-commit-statuses-for-a-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/statuses#list-commit-statuses-for-a-reference" }, "parameters": [ { @@ -34726,14 +40499,14 @@ "/repos/{owner}/{repo}/compare/{basehead}": { "get": { "summary": "Compare two commits", - "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.15/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "repos" ], "operationId": "repos/compare-commits-with-basehead", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/commits#compare-two-commits" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/commits#compare-two-commits" }, "parameters": [ { @@ -34797,14 +40570,14 @@ "/repos/{owner}/{repo}/contents/{path}": { "get": { "summary": "Get repository content", - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.15/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.15/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", "tags": [ "repos" ], "operationId": "repos/get-content", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/contents#get-repository-content" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/contents#get-repository-content" }, "parameters": [ { @@ -34865,7 +40638,16 @@ { "$ref": "#/components/schemas/content-submodule" } - ] + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "array": "#/components/schemas/content-directory", + "file": "#/components/schemas/content-file", + "symlink": "#/components/schemas/content-symlink", + "submodule": "#/components/schemas/content-submodule" + } + } }, "examples": { "response-if-content-is-a-file": { @@ -34887,6 +40669,9 @@ "302": { "$ref": "#/components/responses/found" }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -34904,14 +40689,14 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.15/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", "tags": [ "repos" ], "operationId": "repos/create-or-update-file-contents", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/contents#create-or-update-file-contents" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/contents#create-or-update-file-contents" }, "parameters": [ { @@ -35067,7 +40852,21 @@ "$ref": "#/components/responses/not_found" }, "409": { - "$ref": "#/components/responses/conflict" + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/basic-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } }, "422": { "$ref": "#/components/responses/validation_failed" @@ -35083,14 +40882,14 @@ }, "delete": { "summary": "Delete a file", - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.15/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", "tags": [ "repos" ], "operationId": "repos/delete-file", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/contents#delete-a-file" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/contents#delete-a-file" }, "parameters": [ { @@ -35226,7 +41025,7 @@ "operationId": "repos/list-contributors", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-contributors" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-contributors" }, "parameters": [ { @@ -35304,7 +41103,7 @@ "operationId": "dependabot/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" }, "parameters": [ { @@ -35339,7 +41138,7 @@ }, { "name": "page", - "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "description": "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", "deprecated": true, "in": "query", "schema": { @@ -35349,7 +41148,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "deprecated": true, "in": "query", "schema": { @@ -35425,7 +41224,7 @@ "operationId": "dependabot/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#get-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts#get-a-dependabot-alert" }, "parameters": [ { @@ -35475,14 +41274,14 @@ }, "patch": { "summary": "Update a Dependabot alert", - "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", "tags": [ "dependabot" ], "operationId": "dependabot/update-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#update-a-dependabot-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts#update-a-dependabot-alert" }, "parameters": [ { @@ -35596,7 +41395,7 @@ "operationId": "dependabot/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-repository-secrets" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#list-repository-secrets" }, "parameters": [ { @@ -35668,7 +41467,7 @@ "operationId": "dependabot/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-a-repository-public-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#get-a-repository-public-key" }, "parameters": [ { @@ -35714,7 +41513,7 @@ "operationId": "dependabot/get-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#get-a-repository-secret" }, "parameters": [ { @@ -35754,14 +41553,14 @@ }, "put": { "summary": "Create or update a repository secret", - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "dependabot" ], "operationId": "dependabot/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-a-repository-secret" }, "parameters": [ { @@ -35783,7 +41582,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -35840,7 +41639,7 @@ "operationId": "dependabot/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#delete-a-repository-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#delete-a-repository-secret" }, "parameters": [ { @@ -35877,7 +41676,7 @@ "operationId": "dependency-graph/diff-range", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" }, "parameters": [ { @@ -35945,7 +41744,7 @@ "operationId": "dependency-graph/export-sbom", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" }, "parameters": [ { @@ -36001,7 +41800,7 @@ "operationId": "dependency-graph/create-repository-snapshot", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" }, "parameters": [ { @@ -36086,7 +41885,7 @@ "operationId": "repos/list-deployments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#list-deployments" }, "parameters": [ { @@ -36178,14 +41977,14 @@ }, "post": { "summary": "Create a deployment", - "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/enterprise-server@3.15/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nMerged branch response:\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nFailed commit status checks:\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#create-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#create-a-deployment" }, "parameters": [ { @@ -36218,7 +42017,7 @@ }, "required_contexts": { "type": "array", - "description": "The [status](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "description": "The [status](https://docs.github.com/enterprise-server@3.15/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "items": { "type": "string" } @@ -36351,7 +42150,7 @@ "operationId": "repos/get-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#get-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#get-a-deployment" }, "parameters": [ { @@ -36394,14 +42193,14 @@ }, "delete": { "summary": "Delete a deployment", - "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#delete-a-deployment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#delete-a-deployment" }, "parameters": [ { @@ -36444,7 +42243,7 @@ "operationId": "repos/list-deployment-statuses", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#list-deployment-statuses" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#list-deployment-statuses" }, "parameters": [ { @@ -36508,7 +42307,7 @@ "operationId": "repos/create-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#create-a-deployment-status" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#create-a-deployment-status" }, "parameters": [ { @@ -36543,7 +42342,7 @@ }, "target_url": { "type": "string", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.", "default": "" }, "log_url": { @@ -36634,7 +42433,7 @@ "operationId": "repos/get-deployment-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#get-a-deployment-status" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#get-a-deployment-status" }, "parameters": [ { @@ -36687,14 +42486,14 @@ "/repos/{owner}/{repo}/dispatches": { "post": { "summary": "Create a repository dispatch event", - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-dispatch-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-dispatch-event" }, "parameters": [ { @@ -36722,7 +42521,7 @@ }, "client_payload": { "type": "object", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.", "additionalProperties": true, "maxProperties": 10 } @@ -36772,7 +42571,7 @@ "operationId": "repos/get-all-environments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/environments#list-environments" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/environments#list-environments" }, "parameters": [ { @@ -36830,14 +42629,14 @@ "/repos/{owner}/{repo}/environments/{environment_name}": { "get": { "summary": "Get an environment", - "description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/environments#get-an-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/environments#get-an-environment" }, "parameters": [ { @@ -36877,14 +42676,14 @@ }, "put": { "summary": "Create or update an environment", - "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/environments#create-or-update-an-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/environments#create-or-update-an-environment" }, "parameters": [ { @@ -36908,6 +42707,9 @@ "wait_timer": { "$ref": "#/components/schemas/wait-timer" }, + "prevent_self_review": { + "$ref": "#/components/schemas/prevent-self-review" + }, "reviewers": { "type": "array", "nullable": true, @@ -36936,6 +42738,7 @@ "default": { "value": { "wait_timer": 30, + "prevent_self_review": false, "reviewers": [ { "type": "User", @@ -37000,7 +42803,7 @@ "operationId": "repos/delete-an-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/environments#delete-an-environment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/environments#delete-an-environment" }, "parameters": [ { @@ -37037,7 +42840,7 @@ "operationId": "repos/list-deployment-branch-policies", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/branch-policies#list-deployment-branch-policies" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/branch-policies#list-deployment-branch-policies" }, "parameters": [ { @@ -37100,14 +42903,14 @@ }, "post": { "summary": "Create a deployment branch policy", - "description": "Creates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/create-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/branch-policies#create-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/branch-policies#create-a-deployment-branch-policy" }, "parameters": [ { @@ -37137,7 +42940,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" } } } @@ -37158,6 +42969,9 @@ }, "example-single-branch": { "$ref": "#/components/examples/deployment-branch-policy-single-branch" + }, + "example-single-tag": { + "$ref": "#/components/examples/deployment-branch-policy-single-tag" } } } @@ -37182,14 +42996,14 @@ "/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.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", "tags": [ "repos" ], "operationId": "repos/get-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/branch-policies#get-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/branch-policies#get-a-deployment-branch-policy" }, "parameters": [ { @@ -37232,14 +43046,14 @@ }, "put": { "summary": "Update a deployment branch policy", - "description": "Updates a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/update-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/branch-policies#update-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/branch-policies#update-a-deployment-branch-policy" }, "parameters": [ { @@ -37299,14 +43113,14 @@ }, "delete": { "summary": "Delete a deployment branch policy", - "description": "Deletes a deployment branch policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "repos" ], "operationId": "repos/delete-deployment-branch-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deployments/branch-policies#delete-a-deployment-branch-policy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/branch-policies#delete-a-deployment-branch-policy" }, "parameters": [ { @@ -37336,6 +43150,325 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + "get": { + "summary": "Get all deployment protection rules for an environment", + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-deployment-protection-rules", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + } + ], + "responses": { + "200": { + "description": "List of deployment protection rules", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of enabled custom deployment protection rules for this environment", + "type": "integer", + "example": 10 + }, + "custom_deployment_protection_rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deployment-protection-rule" + } + } + }, + "example": { + "$ref": "#/components/examples/deployment-protection-rules" + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "custom_deployment_protection_rules": [ + { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + }, + { + "id": 4, + "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", + "enabled": true, + "app": { + "id": 1, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a custom deployment protection rule on an environment", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deployment-protection-rule", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "integration_id": { + "type": "integer", + "description": "The ID of the custom app that will be enabled on the environment." + } + } + }, + "examples": { + "default": { + "value": { + "integration_id": 5 + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "The enabled custom deployment protection rule", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-protection-rule" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-protection-rule" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + "get": { + "summary": "List custom deployment rule integrations available for an environment", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/list-custom-deployment-rule-integrations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "A list of custom deployment rule integrations available for this environment.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The total number of custom deployment protection rule integrations available for this environment.", + "type": "integer", + "example": 35 + }, + "available_custom_deployment_protection_rule_integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-deployment-rule-app" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-deployment-protection-rule-apps" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + "get": { + "summary": "Get a custom deployment protection rule", + "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-custom-deployment-protection-rule", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/protection-rule-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-protection-rule" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-protection-rule" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Disable a custom protection rule for an environment", + "description": "Disables a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/disable-deployment-protection-rule", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/protection-rule-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { "get": { "summary": "List environment secrets", @@ -37346,7 +43479,7 @@ "operationId": "actions/list-environment-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-environment-secrets" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#list-environment-secrets" }, "parameters": [ { @@ -37421,7 +43554,7 @@ "operationId": "actions/get-environment-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-an-environment-public-key" }, "parameters": [ { @@ -37470,7 +43603,7 @@ "operationId": "actions/get-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-an-environment-secret" }, "parameters": [ { @@ -37513,14 +43646,14 @@ }, "put": { "summary": "Create or update an environment secret", - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", "tags": [ "actions" ], "operationId": "actions/create-or-update-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-environment-secret" }, "parameters": [ { @@ -37545,7 +43678,7 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-an-environment-public-key) endpoint.", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { @@ -37606,7 +43739,7 @@ "operationId": "actions/delete-environment-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#delete-an-environment-secret" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#delete-an-environment-secret" }, "parameters": [ { @@ -37646,7 +43779,7 @@ "operationId": "actions/list-environment-variables", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#list-environment-variables" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#list-environment-variables" }, "parameters": [ { @@ -37719,7 +43852,7 @@ "operationId": "actions/create-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#create-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#create-an-environment-variable" }, "parameters": [ { @@ -37800,7 +43933,7 @@ "operationId": "actions/get-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#get-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#get-an-environment-variable" }, "parameters": [ { @@ -37850,7 +43983,7 @@ "operationId": "actions/update-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#update-an-environment-variable" }, "parameters": [ { @@ -37916,7 +44049,7 @@ "operationId": "actions/delete-environment-variable", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/actions/variables#delete-an-environment-variable" + "url": "https://docs.github.com/enterprise-server@3.15/rest/actions/variables#delete-an-environment-variable" }, "parameters": [ { @@ -37949,14 +44082,14 @@ "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", - "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-repo-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-repository-events" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-repository-events" }, "parameters": [ { @@ -38011,7 +44144,7 @@ "operationId": "repos/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/forks#list-forks" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/forks#list-forks" }, "parameters": [ { @@ -38081,14 +44214,14 @@ }, "post": { "summary": "Create a fork", - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", + "description": "Create a fork for the authenticated user.\n\n> [!NOTE]\n> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", "tags": [ "repos" ], "operationId": "repos/create-fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/forks#create-a-fork" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/forks#create-a-fork" }, "parameters": [ { @@ -38180,7 +44313,7 @@ "operationId": "git/create-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/blobs#create-a-blob" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/blobs#create-a-blob" }, "parameters": [ { @@ -38256,7 +44389,21 @@ "$ref": "#/components/responses/conflict" }, "422": { - "$ref": "#/components/responses/validation_failed" + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } } }, "x-github": { @@ -38271,14 +44418,14 @@ "/repos/{owner}/{repo}/git/blobs/{file_sha}": { "get": { "summary": "Get a blob", - "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", "tags": [ "git" ], "operationId": "git/get-blob", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/blobs#get-a-blob" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/blobs#get-a-blob" }, "parameters": [ { @@ -38337,14 +44484,14 @@ "/repos/{owner}/{repo}/git/commits": { "post": { "summary": "Create a commit", - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/commits#create-a-commit" }, "parameters": [ { @@ -38371,7 +44518,7 @@ }, "parents": { "type": "array", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", "items": { "type": "string" } @@ -38494,14 +44641,14 @@ "/repos/{owner}/{repo}/git/commits/{commit_sha}": { "get": { "summary": "Get a commit object", - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/get-commit", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/commits#get-a-commit-object" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/commits#get-a-commit-object" }, "parameters": [ { @@ -38549,14 +44696,14 @@ "/repos/{owner}/{repo}/git/matching-refs/{ref}": { "get": { "summary": "List matching references", - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "tags": [ "git" ], "operationId": "git/list-matching-refs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/refs#list-matching-references" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/refs#list-matching-references" }, "parameters": [ { @@ -38609,14 +44756,14 @@ "/repos/{owner}/{repo}/git/ref/{ref}": { "get": { "summary": "Get a reference", - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "tags": [ "git" ], "operationId": "git/get-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/refs#get-a-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/refs#get-a-reference" }, "parameters": [ { @@ -38671,7 +44818,7 @@ "operationId": "git/create-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/refs#create-a-reference" }, "parameters": [ { @@ -38763,7 +44910,7 @@ "operationId": "git/update-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/refs#update-a-reference" }, "parameters": [ { @@ -38848,7 +44995,7 @@ "operationId": "git/delete-ref", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/refs#delete-a-reference" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/refs#delete-a-reference" }, "parameters": [ { @@ -38884,14 +45031,14 @@ "/repos/{owner}/{repo}/git/tags": { "post": { "summary": "Create a tag object", - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.15/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.15/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/create-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/tags#create-a-tag-object" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/tags#create-a-tag-object" }, "parameters": [ { @@ -39021,14 +45168,14 @@ "/repos/{owner}/{repo}/git/tags/{tag_sha}": { "get": { "summary": "Get a tag", - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "tags": [ "git" ], "operationId": "git/get-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/tags#get-a-tag" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/tags#get-a-tag" }, "parameters": [ { @@ -39081,14 +45228,14 @@ "/repos/{owner}/{repo}/git/trees": { "post": { "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.15/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.15/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", "tags": [ "git" ], "operationId": "git/create-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/trees#create-a-tree" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/trees#create-a-tree" }, "parameters": [ { @@ -39149,7 +45296,7 @@ }, "base_tree": { "type": "string", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n" + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." } }, "required": [ @@ -39223,14 +45370,14 @@ "/repos/{owner}/{repo}/git/trees/{tree_sha}": { "get": { "summary": "Get a tree", - "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", "tags": [ "git" ], "operationId": "git/get-tree", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree" + "url": "https://docs.github.com/enterprise-server@3.15/rest/git/trees#get-a-tree" }, "parameters": [ { @@ -39307,7 +45454,7 @@ "operationId": "repos/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#list-repository-webhooks" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#list-repository-webhooks" }, "parameters": [ { @@ -39368,7 +45515,7 @@ "operationId": "repos/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#create-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#create-a-repository-webhook" }, "parameters": [ { @@ -39410,7 +45557,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for.", "default": [ "push" ], @@ -39499,7 +45646,7 @@ "operationId": "repos/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#get-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#get-a-repository-webhook" }, "parameters": [ { @@ -39549,7 +45696,7 @@ "operationId": "repos/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#update-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#update-a-repository-webhook" }, "parameters": [ { @@ -39574,7 +45721,7 @@ }, "events": { "type": "array", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", "default": [ "push" ], @@ -39649,14 +45796,14 @@ }, "delete": { "summary": "Delete a repository webhook", - "description": "", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", "tags": [ "repos" ], "operationId": "repos/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#delete-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#delete-a-repository-webhook" }, "parameters": [ { @@ -39696,7 +45843,7 @@ "operationId": "repos/get-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -39743,7 +45890,7 @@ "operationId": "repos/update-webhook-config-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" }, "parameters": [ { @@ -39826,7 +45973,7 @@ "operationId": "repos/list-webhook-deliveries", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" }, "parameters": [ { @@ -39843,14 +45990,6 @@ }, { "$ref": "#/components/parameters/cursor" - }, - { - "name": "redelivery", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -39898,7 +46037,7 @@ "operationId": "repos/get-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -39956,7 +46095,7 @@ "operationId": "repos/redeliver-webhook-delivery", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" }, "parameters": [ { @@ -39995,14 +46134,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { "post": { "summary": "Ping a repository webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) to be sent to the hook.", "tags": [ "repos" ], "operationId": "repos/ping-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#ping-a-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#ping-a-repository-webhook" }, "parameters": [ { @@ -40035,14 +46174,14 @@ "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { "post": { "summary": "Test the push repository webhook", - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", "tags": [ "repos" ], "operationId": "repos/test-push-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#test-the-push-repository-webhook" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/webhooks#test-the-push-repository-webhook" }, "parameters": [ { @@ -40075,14 +46214,14 @@ "/repos/{owner}/{repo}/installation": { "get": { "summary": "Get a repository installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-repo-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" }, "parameters": [ { @@ -40134,7 +46273,7 @@ "operationId": "repos/list-invitations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#list-repository-invitations" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/invitations#list-repository-invitations" }, "parameters": [ { @@ -40194,7 +46333,7 @@ "operationId": "repos/update-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#update-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/invitations#update-a-repository-invitation" }, "parameters": [ { @@ -40272,7 +46411,7 @@ "operationId": "repos/delete-invitation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#delete-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/invitations#delete-a-repository-invitation" }, "parameters": [ { @@ -40302,14 +46441,14 @@ "/repos/{owner}/{repo}/issues": { "get": { "summary": "List repository issues", - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-repository-issues" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#list-repository-issues" }, "parameters": [ { @@ -40444,14 +46583,14 @@ }, "post": { "summary": "Create an issue", - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.9/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.15/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#create-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#create-an-issue" }, "parameters": [ { @@ -40485,7 +46624,7 @@ }, "assignee": { "type": "string", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_", "nullable": true }, "milestone": { @@ -40616,14 +46755,14 @@ "/repos/{owner}/{repo}/issues/comments": { "get": { "summary": "List issue comments for a repository", - "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/comments#list-issue-comments-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/comments#list-issue-comments-for-a-repository" }, "parameters": [ { @@ -40701,14 +46840,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}": { "get": { "summary": "Get an issue comment", - "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment" }, "parameters": [ { @@ -40751,14 +46890,14 @@ }, "patch": { "summary": "Update an issue comment", - "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/comments#update-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/comments#update-an-issue-comment" }, "parameters": [ { @@ -40834,7 +46973,7 @@ "operationId": "issues/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/comments#delete-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/comments#delete-an-issue-comment" }, "parameters": [ { @@ -40864,14 +47003,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for an issue comment", - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment).", + "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-an-issue-comment" }, "parameters": [ { @@ -40885,7 +47024,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", "in": "query", "required": false, "schema": { @@ -40947,14 +47086,14 @@ }, "post": { "summary": "Create reaction for an issue comment", - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-an-issue-comment" }, "parameters": [ { @@ -40976,7 +47115,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the issue comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the issue comment.", "enum": [ "+1", "-1", @@ -41050,14 +47189,14 @@ "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#delete-an-issue-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-an-issue-comment-reaction" }, "parameters": [ { @@ -41097,7 +47236,7 @@ "operationId": "issues/list-events-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/events#list-issue-events-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/events#list-issue-events-for-a-repository" }, "parameters": [ { @@ -41160,7 +47299,7 @@ "operationId": "issues/get-event", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/events#get-an-issue-event" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/events#get-an-issue-event" }, "parameters": [ { @@ -41216,14 +47355,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}": { "get": { "summary": "Get an issue", - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.15/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue" }, "parameters": [ { @@ -41275,14 +47414,14 @@ }, "patch": { "summary": "Update an issue", - "description": "Issue owners and users with push access can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#update-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#update-an-issue" }, "parameters": [ { @@ -41322,7 +47461,7 @@ "assignee": { "type": "string", "nullable": true, - "description": "Username to assign to this issue. **This field is deprecated.**" + "description": "Username to assign to this issue. **This field is closing down.**" }, "state": { "type": "string", @@ -41467,7 +47606,7 @@ "operationId": "issues/add-assignees", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#add-assignees-to-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/assignees#add-assignees-to-an-issue" }, "parameters": [ { @@ -41624,7 +47763,7 @@ "operationId": "issues/check-user-can-be-assigned-to-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" }, "parameters": [ { @@ -41672,14 +47811,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/comments": { "get": { "summary": "List issue comments", - "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/comments#list-issue-comments" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/comments#list-issue-comments" }, "parameters": [ { @@ -41742,14 +47881,14 @@ }, "post": { "summary": "Create an issue comment", - "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/comments#create-an-issue-comment" }, "parameters": [ { @@ -41845,7 +47984,7 @@ "operationId": "issues/list-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/events#list-issue-events" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/events#list-issue-events" }, "parameters": [ { @@ -41911,7 +48050,7 @@ "operationId": "issues/list-labels-on-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#list-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#list-labels-for-an-issue" }, "parameters": [ { @@ -41981,7 +48120,7 @@ "operationId": "issues/add-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#add-labels-to-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#add-labels-to-an-issue" }, "parameters": [ { @@ -42006,7 +48145,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#set-labels-for-an-issue).\"", + "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see \"[Set labels for an issue](https://docs.github.com/enterprise-server@3.15/rest/issues/labels#set-labels-for-an-issue).\"", "items": { "type": "string" } @@ -42097,7 +48236,7 @@ "operationId": "issues/set-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#set-labels-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#set-labels-for-an-issue" }, "parameters": [ { @@ -42122,7 +48261,7 @@ "labels": { "type": "array", "minItems": 1, - "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#add-labels-to-an-issue).\"", + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/enterprise-server@3.15/rest/issues/labels#add-labels-to-an-issue).\"", "items": { "type": "string" } @@ -42213,7 +48352,7 @@ "operationId": "issues/remove-all-labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#remove-all-labels-from-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#remove-all-labels-from-an-issue" }, "parameters": [ { @@ -42259,7 +48398,7 @@ "operationId": "issues/remove-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#remove-a-label-from-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#remove-a-label-from-an-issue" }, "parameters": [ { @@ -42321,14 +48460,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/lock": { "put": { "summary": "Lock an issue", - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "issues" ], "operationId": "issues/lock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#lock-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#lock-an-issue" }, "parameters": [ { @@ -42406,7 +48545,7 @@ "operationId": "issues/unlock", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#unlock-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#unlock-an-issue" }, "parameters": [ { @@ -42442,14 +48581,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { "get": { "summary": "List reactions for an issue", - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue).", + "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/list-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-an-issue" }, "parameters": [ { @@ -42463,7 +48602,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", "in": "query", "required": false, "schema": { @@ -42528,14 +48667,14 @@ }, "post": { "summary": "Create reaction for an issue", - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", + "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", "tags": [ "reactions" ], "operationId": "reactions/create-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-an-issue" }, "parameters": [ { @@ -42557,7 +48696,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the issue.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the issue.", "enum": [ "+1", "-1", @@ -42631,14 +48770,14 @@ "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { "delete": { "summary": "Delete an issue reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-issue", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#delete-an-issue-reaction" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-an-issue-reaction" }, "parameters": [ { @@ -42678,7 +48817,7 @@ "operationId": "issues/list-events-for-timeline", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/timeline#list-timeline-events-for-an-issue" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/timeline#list-timeline-events-for-an-issue" }, "parameters": [ { @@ -42747,7 +48886,7 @@ "operationId": "repos/list-deploy-keys", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#list-deploy-keys" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deploy-keys/deploy-keys#list-deploy-keys" }, "parameters": [ { @@ -42805,7 +48944,7 @@ "operationId": "repos/create-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#create-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deploy-keys/deploy-keys#create-a-deploy-key" }, "parameters": [ { @@ -42832,7 +48971,7 @@ }, "read_only": { "type": "boolean", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.9/articles/permission-levels-for-a-user-account-repository/).\"" + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.15/articles/permission-levels-for-a-user-account-repository/).\"" } }, "required": [ @@ -42898,7 +49037,7 @@ "operationId": "repos/get-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#get-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deploy-keys/deploy-keys#get-a-deploy-key" }, "parameters": [ { @@ -42948,7 +49087,7 @@ "operationId": "repos/delete-deploy-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#delete-a-deploy-key" + "url": "https://docs.github.com/enterprise-server@3.15/rest/deploy-keys/deploy-keys#delete-a-deploy-key" }, "parameters": [ { @@ -42985,7 +49124,7 @@ "operationId": "issues/list-labels-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#list-labels-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#list-labels-for-a-repository" }, "parameters": [ { @@ -43046,7 +49185,7 @@ "operationId": "issues/create-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#create-a-label" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#create-a-label" }, "parameters": [ { @@ -43142,7 +49281,7 @@ "operationId": "issues/get-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#get-a-label" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#get-a-label" }, "parameters": [ { @@ -43197,7 +49336,7 @@ "operationId": "issues/update-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#update-a-label" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#update-a-label" }, "parameters": [ { @@ -43282,7 +49421,7 @@ "operationId": "issues/delete-label", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#delete-a-label" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#delete-a-label" }, "parameters": [ { @@ -43324,7 +49463,7 @@ "operationId": "repos/list-languages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-languages" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-languages" }, "parameters": [ { @@ -43370,7 +49509,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/lfs#enable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/lfs#enable-git-lfs-for-a-repository" }, "parameters": [ { @@ -43405,7 +49544,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/lfs#disable-git-lfs-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/lfs#disable-git-lfs-for-a-repository" }, "parameters": [ { @@ -43432,14 +49571,14 @@ "/repos/{owner}/{repo}/license": { "get": { "summary": "Get the license for a repository", - "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "licenses" ], "operationId": "licenses/get-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/licenses/licenses#get-the-license-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/licenses/licenses#get-the-license-for-a-repository" }, "parameters": [ { @@ -43447,6 +49586,9 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref" } ], "responses": { @@ -43488,7 +49630,7 @@ "operationId": "repos/merge-upstream", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" }, "parameters": [ { @@ -43566,7 +49708,7 @@ "operationId": "repos/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/branches/branches#merge-a-branch" + "url": "https://docs.github.com/enterprise-server@3.15/rest/branches/branches#merge-a-branch" }, "parameters": [ { @@ -43664,7 +49806,7 @@ "operationId": "issues/list-milestones", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#list-milestones" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/milestones#list-milestones" }, "parameters": [ { @@ -43768,7 +49910,7 @@ "operationId": "issues/create-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#create-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/milestones#create-a-milestone" }, "parameters": [ { @@ -43875,7 +50017,7 @@ "operationId": "issues/get-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#get-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/milestones#get-a-milestone" }, "parameters": [ { @@ -43925,7 +50067,7 @@ "operationId": "issues/update-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#update-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/milestones#update-a-milestone" }, "parameters": [ { @@ -44016,7 +50158,7 @@ "operationId": "issues/delete-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#delete-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/milestones#delete-a-milestone" }, "parameters": [ { @@ -44056,7 +50198,7 @@ "operationId": "issues/list-labels-for-milestone", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/labels#list-labels-for-issues-in-a-milestone" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/labels#list-labels-for-issues-in-a-milestone" }, "parameters": [ { @@ -44119,7 +50261,7 @@ "operationId": "activity/list-repo-notifications-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" }, "parameters": [ { @@ -44182,14 +50324,14 @@ }, "put": { "summary": "Mark repository notifications as read", - "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "tags": [ "activity" ], "operationId": "activity/mark-repo-notifications-as-read", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#mark-repository-notifications-as-read" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#mark-repository-notifications-as-read" }, "parameters": [ { @@ -44272,7 +50414,7 @@ "operationId": "repos/get-pages", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#get-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#get-a-apiname-pages-site" }, "parameters": [ { @@ -44319,7 +50461,7 @@ "operationId": "repos/create-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#create-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#create-a-apiname-pages-site" }, "parameters": [ { @@ -44435,7 +50577,7 @@ "operationId": "repos/update-information-about-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#update-information-about-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#update-information-about-a-apiname-pages-site" }, "parameters": [ { @@ -44454,7 +50596,7 @@ "properties": { "cname": { "type": "string", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.9/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.15/pages/configuring-a-custom-domain-for-your-github-pages-site).\"", "nullable": true }, "https_enforced": { @@ -44578,7 +50720,7 @@ "operationId": "repos/delete-pages-site", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#delete-a-apiname-pages-site" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#delete-a-apiname-pages-site" }, "parameters": [ { @@ -44621,7 +50763,7 @@ "operationId": "repos/list-pages-builds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#list-apiname-pages-builds" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#list-apiname-pages-builds" }, "parameters": [ { @@ -44679,7 +50821,7 @@ "operationId": "repos/request-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#request-a-apiname-pages-build" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#request-a-apiname-pages-build" }, "parameters": [ { @@ -44725,7 +50867,7 @@ "operationId": "repos/get-latest-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#get-latest-pages-build" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#get-latest-pages-build" }, "parameters": [ { @@ -44771,7 +50913,7 @@ "operationId": "repos/get-pages-build", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#get-apiname-pages-build" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#get-apiname-pages-build" }, "parameters": [ { @@ -44825,7 +50967,7 @@ "operationId": "repos/create-pages-deployment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pages/pages#create-a-github-pages-deployment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#create-a-github-pages-deployment" }, "parameters": [ { @@ -44917,6 +51059,98 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + "get": { + "summary": "Get the status of a GitHub Pages deployment", + "description": "Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.", + "tags": [ + "repos" + ], + "operationId": "repos/get-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#get-the-status-of-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pages-deployment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pages-deployment-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pages-deployment-status" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + "post": { + "summary": "Cancel a GitHub Pages deployment", + "description": "Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.", + "tags": [ + "repos" + ], + "operationId": "repos/cancel-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/pages/pages#cancel-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pages-deployment-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/pre-receive-hooks": { "get": { "summary": "List pre-receive hooks for a repository", @@ -44927,7 +51161,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository" }, "parameters": [ { @@ -44999,7 +51233,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository" }, "parameters": [ { @@ -45046,7 +51280,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository" }, "parameters": [ { @@ -45121,7 +51355,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository" }, "parameters": [ { @@ -45170,7 +51404,7 @@ "operationId": "projects/list-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#list-repository-projects" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#list-repository-projects" }, "parameters": [ { @@ -45258,7 +51492,7 @@ "operationId": "projects/create-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#create-a-repository-project" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#create-a-repository-project" }, "parameters": [ { @@ -45340,17 +51574,140 @@ "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 read 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-server@3.15/rest/repos/custom-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": "custom-properties" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/pulls": { "get": { "summary": "List pull requests", - "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests" }, "parameters": [ { @@ -45469,14 +51826,14 @@ }, "post": { "summary": "Create a pull request", - "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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#create-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#create-a-pull-request" }, "parameters": [ { @@ -45517,11 +51874,11 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.9/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.15/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." }, "draft": { "type": "boolean", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.9/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.15/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." }, "issue": { "type": "integer", @@ -45592,14 +51949,14 @@ "/repos/{owner}/{repo}/pulls/comments": { "get": { "summary": "List review comments in a repository", - "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#list-review-comments-in-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#list-review-comments-in-a-repository" }, "parameters": [ { @@ -45681,14 +52038,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { "get": { "summary": "Get a review comment for a pull request", - "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -45731,14 +52088,14 @@ }, "patch": { "summary": "Update a review comment for a pull request", - "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#update-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#update-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -45811,7 +52168,7 @@ "operationId": "pulls/delete-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -45844,14 +52201,14 @@ "/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/rest/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.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/list-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" }, "parameters": [ { @@ -45865,7 +52222,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", "in": "query", "required": false, "schema": { @@ -45927,14 +52284,14 @@ }, "post": { "summary": "Create reaction for a pull request review comment", - "description": "Create a reaction 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). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", "tags": [ "reactions" ], "operationId": "reactions/create-for-pull-request-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" }, "parameters": [ { @@ -45956,7 +52313,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", "enum": [ "+1", "-1", @@ -46030,14 +52387,14 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a pull request comment reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction 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).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-pull-request-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#delete-a-pull-request-comment-reaction" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-a-pull-request-comment-reaction" }, "parameters": [ { @@ -46070,14 +52427,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}": { "get": { "summary": "Get a pull request", - "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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", "tags": [ "pulls" ], "operationId": "pulls/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request" }, "parameters": [ { @@ -46092,7 +52449,7 @@ ], "responses": { "200": { - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", "content": { "application/json": { "schema": { @@ -46132,14 +52489,14 @@ }, "patch": { "summary": "Update a pull request", - "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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#update-a-pull-request" }, "parameters": [ { @@ -46181,7 +52538,7 @@ }, "maintainer_can_modify": { "type": "boolean", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.9/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.15/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." } } }, @@ -46233,14 +52590,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { "get": { "summary": "List review comments on a pull request", - "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-review-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#list-review-comments-on-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#list-review-comments-on-a-pull-request" }, "parameters": [ { @@ -46313,14 +52670,14 @@ }, "post": { "summary": "Create a review comment for a pull request", - "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#create-a-review-comment-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#create-a-review-comment-for-a-pull-request" }, "parameters": [ { @@ -46354,7 +52711,7 @@ }, "position": { "type": "integer", - "description": "**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "deprecated": true, "x-github": { "deprecationDate": "2022-11-01" @@ -46362,7 +52719,7 @@ }, "side": { "type": "string", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.9/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.15/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "enum": [ "LEFT", "RIGHT" @@ -46374,11 +52731,11 @@ }, "start_line": { "type": "integer", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." }, "start_side": { "type": "string", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "enum": [ "LEFT", "RIGHT", @@ -46466,14 +52823,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { "post": { "summary": "Create a reply for a review comment", - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-reply-for-review-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#create-a-reply-for-a-review-comment" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#create-a-reply-for-a-review-comment" }, "parameters": [ { @@ -46556,14 +52913,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { "get": { "summary": "List commits on a pull request", - "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-commits-on-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-commits-on-a-pull-request" }, "parameters": [ { @@ -46619,14 +52976,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/files": { "get": { "summary": "List pull requests files", - "description": "Lists the files in a specified pull request.\n\n**Note:** Responses include a maximum of 3000 files. The paginated response\nreturns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-files", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests-files" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests-files" }, "parameters": [ { @@ -46698,7 +53055,7 @@ "operationId": "pulls/check-if-merged", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" }, "parameters": [ { @@ -46729,14 +53086,14 @@ }, "put": { "summary": "Merge a pull request", - "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "pulls" ], "operationId": "pulls/merge", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#merge-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#merge-a-pull-request" }, "parameters": [ { @@ -46880,14 +53237,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { "summary": "Get all requested reviewers for a pull request", - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": [ "pulls" ], "operationId": "pulls/list-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -47033,7 +53390,7 @@ "operationId": "pulls/remove-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" }, "parameters": [ { @@ -47121,14 +53478,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { "get": { "summary": "List reviews for a pull request", - "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-reviews", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-reviews-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#list-reviews-for-a-pull-request" }, "parameters": [ { @@ -47182,14 +53539,14 @@ }, "post": { "summary": "Create a review for a pull request", - "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/create-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#create-a-review-for-a-pull-request" }, "parameters": [ { @@ -47219,7 +53576,7 @@ }, "event": { "type": "string", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -47324,14 +53681,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { "get": { "summary": "Get a review for a pull request", - "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/get-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#get-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#get-a-review-for-a-pull-request" }, "parameters": [ { @@ -47377,14 +53734,14 @@ }, "put": { "summary": "Update a review for a pull request", - "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/update-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#update-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#update-a-review-for-a-pull-request" }, "parameters": [ { @@ -47456,14 +53813,14 @@ }, "delete": { "summary": "Delete a pending review for a pull request", - "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/delete-pending-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" }, "parameters": [ { @@ -47514,14 +53871,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { "get": { "summary": "List comments for a pull request review", - "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/list-comments-for-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-comments-for-a-pull-request-review" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#list-comments-for-a-pull-request-review" }, "parameters": [ { @@ -47583,14 +53940,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { "put": { "summary": "Dismiss a review for a pull request", - "description": "Dismisses a specified review on a pull request.\n\n**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection),\nyou must be a repository administrator or be included in the list of people or teams\nwho can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/dismiss-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" }, "parameters": [ { @@ -47675,14 +54032,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { "post": { "summary": "Submit a review for a pull request", - "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "pulls" ], "operationId": "pulls/submit-review", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#submit-a-review-for-a-pull-request" }, "parameters": [ { @@ -47772,14 +54129,14 @@ "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { "put": { "summary": "Update a pull request branch", - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.", "tags": [ "pulls" ], "operationId": "pulls/update-branch", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request-branch" + "url": "https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#update-a-pull-request-branch" }, "parameters": [ { @@ -47802,7 +54159,7 @@ "properties": { "expected_head_sha": { "type": "string", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." } } }, @@ -47862,14 +54219,14 @@ "/repos/{owner}/{repo}/readme": { "get": { "summary": "Get a repository README", - "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/contents#get-a-repository-readme" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/contents#get-a-repository-readme" }, "parameters": [ { @@ -47904,6 +54261,9 @@ } } }, + "304": { + "$ref": "#/components/responses/not_modified" + }, "404": { "$ref": "#/components/responses/not_found" }, @@ -47923,14 +54283,14 @@ "/repos/{owner}/{repo}/readme/{dir}": { "get": { "summary": "Get a repository README for a directory", - "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", "tags": [ "repos" ], "operationId": "repos/get-readme-in-directory", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/contents#get-a-repository-readme-for-a-directory" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/contents#get-a-repository-readme-for-a-directory" }, "parameters": [ { @@ -47994,14 +54354,14 @@ "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", "tags": [ "repos" ], "operationId": "repos/list-releases", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#list-releases" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#list-releases" }, "parameters": [ { @@ -48055,14 +54415,14 @@ }, "post": { "summary": "Create a release", - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"", "tags": [ "repos" ], "operationId": "repos/create-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#create-a-release" }, "parameters": [ { @@ -48118,7 +54478,7 @@ "false", "legacy" ], - "default": true + "default": "true" } }, "required": [ @@ -48182,14 +54542,14 @@ "/repos/{owner}/{repo}/releases/assets/{asset_id}": { "get": { "summary": "Get a release asset", - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", "tags": [ "repos" ], "operationId": "repos/get-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/assets#get-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/assets#get-a-release-asset" }, "parameters": [ { @@ -48242,7 +54602,7 @@ "operationId": "repos/update-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/assets#update-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/assets#update-a-release-asset" }, "parameters": [ { @@ -48321,7 +54681,7 @@ "operationId": "repos/delete-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/assets#delete-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/assets#delete-a-release-asset" }, "parameters": [ { @@ -48351,14 +54711,14 @@ "/repos/{owner}/{repo}/releases/generate-notes": { "post": { "summary": "Generate release notes content for a release", - "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", + "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", "tags": [ "repos" ], "operationId": "repos/generate-release-notes", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#generate-release-notes-content-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#generate-release-notes-content-for-a-release" }, "parameters": [ { @@ -48448,7 +54808,7 @@ "operationId": "repos/get-latest-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-the-latest-release" }, "parameters": [ { @@ -48494,7 +54854,7 @@ "operationId": "repos/get-release-by-tag", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release-by-tag-name" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release-by-tag-name" }, "parameters": [ { @@ -48546,14 +54906,14 @@ "/repos/{owner}/{repo}/releases/{release_id}": { "get": { "summary": "Get a release", - "description": "Gets a public release with the specified release ID.\n\n**Note:** This returns an `upload_url` key corresponding to the endpoint\nfor uploading release assets. This key is a hypermedia resource. For more information, see\n\"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "tags": [ "repos" ], "operationId": "repos/get-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release" }, "parameters": [ { @@ -48568,7 +54928,7 @@ ], "responses": { "200": { - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", "content": { "application/json": { "schema": { @@ -48603,7 +54963,7 @@ "operationId": "repos/update-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#update-a-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#update-a-release" }, "parameters": [ { @@ -48708,7 +55068,7 @@ "operationId": "repos/delete-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/releases#delete-a-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/releases#delete-a-release" }, "parameters": [ { @@ -48745,7 +55105,7 @@ "operationId": "repos/list-release-assets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/assets#list-release-assets" }, "parameters": [ { @@ -48799,18 +55159,18 @@ }, "post": { "summary": "Upload a release asset", - "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", + "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/enterprise-server@3.15/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", "tags": [ "repos" ], "operationId": "repos/upload-release-asset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/releases/assets#upload-a-release-asset" + "url": "https://docs.github.com/enterprise-server@3.15/rest/releases/assets#upload-a-release-asset" }, "servers": [ { - "url": "https://uploads.github.com", + "url": "https://HOSTNAME/api/uploads", "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], @@ -48889,14 +55249,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions": { "get": { "summary": "List reactions for a release", - "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release).", + "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/list-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-release" }, "parameters": [ { @@ -48910,7 +55270,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", "in": "query", "required": false, "schema": { @@ -48970,14 +55330,14 @@ }, "post": { "summary": "Create reaction for a release", - "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", + "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", "tags": [ "reactions" ], "operationId": "reactions/create-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-release" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-release" }, "parameters": [ { @@ -48999,7 +55359,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the release.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the release.", "enum": [ "+1", "laugh", @@ -49071,14 +55431,14 @@ "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { "delete": { "summary": "Delete a release reaction", - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release).", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release).", "tags": [ "reactions" ], "operationId": "reactions/delete-for-release", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#delete-a-release-reaction" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-a-release-reaction" }, "parameters": [ { @@ -49118,7 +55478,7 @@ "operationId": "repos/list-cache-info", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-cache-replication-status" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-cache-replication-status" }, "parameters": [ { @@ -49235,6 +55595,659 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/rules/branches/{branch}": { + "get": { + "summary": "Get rules for a branch", + "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.", + "tags": [ + "repos" + ], + "operationId": "repos/get-branch-rules", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/rules#get-rules-for-a-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule-detailed" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-rule-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/rulesets": { + "get": { + "summary": "Get all repository rulesets", + "description": "Get all the rulesets for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rulesets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/rules#get-all-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "includes_parents", + "description": "Include rulesets configured at higher levels that apply to this repository", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + }, + { + "$ref": "#/components/parameters/ruleset-targets" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "post": { + "summary": "Create a repository ruleset", + "description": "Create a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/rules#create-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "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-server@3.15/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-server@3.15/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-server@3.15/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-server@3.15/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", + "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/rules#get-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "includes_parents", + "description": "Include rulesets configured at higher levels that apply to this repository", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "put": { + "summary": "Update a repository ruleset", + "description": "Update a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/update-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/rules#update-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a repository ruleset", + "description": "Delete a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/rules#delete-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for a repository", @@ -49245,7 +56258,7 @@ "operationId": "secret-scanning/list-alerts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" }, "parameters": [ { @@ -49280,6 +56293,9 @@ }, { "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" } ], "responses": { @@ -49327,7 +56343,7 @@ "operationId": "secret-scanning/get-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" }, "parameters": [ { @@ -49383,7 +56399,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" }, "parameters": [ { @@ -49476,7 +56492,7 @@ "operationId": "secret-scanning/list-locations-for-alert", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" + "url": "https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" }, "parameters": [ { @@ -49536,17 +56552,105 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + "post": { + "summary": "Create a push protection bypass", + "description": "Creates a bypass for a previously push protected secret.\n\nThe authenticated user must be the original author of the committed secret.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "secret-scanning/create-push-protection-bypass", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + } + }, + "required": [ + "reason", + "placeholder_id" + ] + }, + "examples": { + "default": { + "value": { + "reason": "will_fix_later", + "placeholder_id": "2k4dM4tseyC5lPIsjl5emX9sPNk" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-push-protection-bypass" + } + } + } + } + }, + "403": { + "description": "User does not have enough permissions to perform this action." + }, + "404": { + "description": "Placeholder ID not found, or push protection is disabled on this repository." + }, + "422": { + "description": "Bad request, input data missing or incorrect." + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "secret-scanning", + "subcategory": "secret-scanning" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/stargazers": { "get": { "summary": "List stargazers", - "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-stargazers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/starring#list-stargazers" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/starring#list-stargazers" }, "parameters": [ { @@ -49622,7 +56726,7 @@ "operationId": "repos/get-code-frequency-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/metrics/statistics#get-the-weekly-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.15/rest/metrics/statistics#get-the-weekly-commit-activity" }, "parameters": [ { @@ -49677,7 +56781,7 @@ "operationId": "repos/get-commit-activity-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/metrics/statistics#get-the-last-year-of-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.15/rest/metrics/statistics#get-the-last-year-of-commit-activity" }, "parameters": [ { @@ -49732,7 +56836,7 @@ "operationId": "repos/get-contributors-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/metrics/statistics#get-all-contributor-commit-activity" + "url": "https://docs.github.com/enterprise-server@3.15/rest/metrics/statistics#get-all-contributor-commit-activity" }, "parameters": [ { @@ -49787,7 +56891,7 @@ "operationId": "repos/get-participation-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/metrics/statistics#get-the-weekly-commit-count" + "url": "https://docs.github.com/enterprise-server@3.15/rest/metrics/statistics#get-the-weekly-commit-count" }, "parameters": [ { @@ -49836,7 +56940,7 @@ "operationId": "repos/get-punch-card-stats", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" + "url": "https://docs.github.com/enterprise-server@3.15/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" }, "parameters": [ { @@ -49888,7 +56992,7 @@ "operationId": "repos/create-commit-status", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/commits/statuses#create-a-commit-status" + "url": "https://docs.github.com/enterprise-server@3.15/rest/commits/statuses#create-a-commit-status" }, "parameters": [ { @@ -50001,7 +57105,7 @@ "operationId": "activity/list-watchers-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/watching#list-watchers" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/watching#list-watchers" }, "parameters": [ { @@ -50061,7 +57165,7 @@ "operationId": "activity/get-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/watching#get-a-repository-subscription" }, "parameters": [ { @@ -50104,14 +57208,14 @@ }, "put": { "summary": "Set a repository subscription", - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription) completely.", + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#delete-a-repository-subscription) completely.", "tags": [ "activity" ], "operationId": "activity/set-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/watching#set-a-repository-subscription" }, "parameters": [ { @@ -50176,14 +57280,14 @@ }, "delete": { "summary": "Delete a repository subscription", - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription).", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#set-a-repository-subscription).", "tags": [ "activity" ], "operationId": "activity/delete-repo-subscription", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/watching#delete-a-repository-subscription" }, "parameters": [ { @@ -50217,7 +57321,7 @@ "operationId": "repos/list-tags", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-tags" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-tags" }, "parameters": [ { @@ -50269,15 +57373,15 @@ }, "/repos/{owner}/{repo}/tags/protection": { "get": { - "summary": "List tag protection states for a repository", - "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", + "summary": "Closing down - List tag protection states for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#get-all-repository-rulesets)\" endpoint instead.\n\nThis returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/list-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/tags#list-tag-protection-states-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository" }, "parameters": [ { @@ -50317,20 +57421,23 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} }, "post": { - "summary": "Create a tag protection state for a repository", - "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Create a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#create-a-repository-ruleset)\" endpoint instead.\n\nThis creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/create-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/tags#create-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -50393,22 +57500,25 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { "delete": { - "summary": "Delete a tag protection state for a repository", - "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", + "summary": "Closing down - Delete a tag protection state for a repository", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the \"[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#delete-a-repository-ruleset)\" endpoint instead.\n\nThis deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", "tags": [ "repos" ], "operationId": "repos/delete-tag-protection", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/tags#delete-a-tag-protection-state-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository" }, "parameters": [ { @@ -50436,21 +57546,24 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "repos", - "subcategory": "tags" + "subcategory": "tags", + "deprecationDate": "2024-05-29", + "removalDate": "2024-08-30" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/tarball/{ref}": { "get": { "summary": "Download a repository archive (tar)", - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", "tags": [ "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/contents#download-a-repository-archive-tar" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/contents#download-a-repository-archive-tar" }, "operationId": "repos/download-tarball-archive", "parameters": [ @@ -50512,7 +57625,7 @@ "operationId": "repos/list-teams", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-teams" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-teams" }, "parameters": [ { @@ -50575,7 +57688,7 @@ "operationId": "repos/get-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-all-repository-topics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-all-repository-topics" }, "parameters": [ { @@ -50628,7 +57741,7 @@ "operationId": "repos/replace-all-topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#replace-all-repository-topics" }, "parameters": [ { @@ -50647,7 +57760,7 @@ "properties": { "names": { "type": "array", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.", "items": { "type": "string" } @@ -50707,14 +57820,14 @@ "/repos/{owner}/{repo}/transfer": { "post": { "summary": "Transfer a repository", - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/).\nYou must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account.", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.15/articles/about-repository-transfers/).", "tags": [ "repos" ], "operationId": "repos/transfer", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#transfer-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#transfer-a-repository" }, "parameters": [ { @@ -50795,14 +57908,14 @@ "/repos/{owner}/{repo}/vulnerability-alerts": { "get": { "summary": "Check if vulnerability alerts are enabled for a repository", - "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/check-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" }, "parameters": [ { @@ -50830,14 +57943,14 @@ }, "put": { "summary": "Enable vulnerability alerts", - "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/enable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#enable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#enable-vulnerability-alerts" }, "parameters": [ { @@ -50862,14 +57975,14 @@ }, "delete": { "summary": "Disable vulnerability alerts", - "description": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "description": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)\".", "tags": [ "repos" ], "operationId": "repos/disable-vulnerability-alerts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#disable-vulnerability-alerts" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#disable-vulnerability-alerts" }, "parameters": [ { @@ -50896,13 +58009,13 @@ "/repos/{owner}/{repo}/zipball/{ref}": { "get": { "summary": "Download a repository archive (zip)", - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "tags": [ "repos" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/contents#download-a-repository-archive-zip" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/contents#download-a-repository-archive-zip" }, "operationId": "repos/download-zipball-archive", "parameters": [ @@ -50957,14 +58070,14 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", "tags": [ "repos" ], "operationId": "repos/create-using-template", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-using-a-template" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-using-a-template" }, "parameters": [ { @@ -51061,14 +58174,14 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "repos", "subcategory": "repos", "previews": [ { "required": true, "name": "baptiste", - "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ] }, @@ -51078,14 +58191,14 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", "tags": [ "repos" ], "operationId": "repos/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-public-repositories" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-public-repositories" }, "parameters": [ { @@ -51153,7 +58266,7 @@ "/scim/v2/enterprises/{enterprise}/Groups": { "get": { "summary": "List provisioned SCIM groups for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "operationId": "enterprise-admin/list-provisioned-groups-enterprise", "tags": [ "enterprise-admin", @@ -51161,7 +58274,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise" }, "parameters": [ { @@ -51236,14 +58349,14 @@ }, "post": { "summary": "Provision a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", "operationId": "enterprise-admin/provision-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#provision-a-scim-enterprise-group" }, "parameters": [ { @@ -51318,14 +58431,14 @@ "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM group.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group" }, "parameters": [ { @@ -51383,14 +58496,14 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group" }, "parameters": [ { @@ -51493,14 +58606,14 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise group", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", "operationId": "enterprise-admin/update-attribute-for-enterprise-group", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group" }, "parameters": [ { @@ -51613,14 +58726,14 @@ }, "delete": { "summary": "Delete a SCIM group from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nDeletes a SCIM group from an enterprise.", "operationId": "enterprise-admin/delete-scim-group-from-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise" }, "parameters": [ { @@ -51665,14 +58778,14 @@ "/scim/v2/enterprises/{enterprise}/Users": { "get": { "summary": "List SCIM provisioned identities for an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.", "operationId": "enterprise-admin/list-provisioned-identities-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise" }, "parameters": [ { @@ -51744,14 +58857,14 @@ }, "post": { "summary": "Provision a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", "operationId": "enterprise-admin/provision-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#provision-a-scim-enterprise-user" }, "parameters": [ { @@ -51826,14 +58939,14 @@ "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { "get": { "summary": "Get SCIM provisioning information for an enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nGets information about a SCIM user.", "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user" }, "parameters": [ { @@ -51888,14 +59001,14 @@ }, "put": { "summary": "Set SCIM information for a provisioned enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user" }, "parameters": [ { @@ -51968,14 +59081,14 @@ }, "patch": { "summary": "Update an attribute for a SCIM enterprise user", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n> [!NOTE]\n> Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n> [!WARNING]\n> Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n> ```\n> {\n> \"Operations\":[{\n> \"op\":\"replace\",\n> \"value\":{\n> \"active\":false\n> }\n> }]\n> }\n> ```", "operationId": "enterprise-admin/update-attribute-for-enterprise-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user" }, "parameters": [ { @@ -52106,14 +59219,14 @@ }, "delete": { "summary": "Delete a SCIM user from an enterprise", - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", + "description": "> [!NOTE]\n> The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", "operationId": "enterprise-admin/delete-user-from-enterprise", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise" }, "parameters": [ { @@ -52158,19 +59271,19 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", "tags": [ "search" ], "operationId": "search/code", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code" + "url": "https://docs.github.com/enterprise-server@3.15/rest/search/search#search-code" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -52179,7 +59292,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -52270,19 +59383,19 @@ "/search/commits": { "get": { "summary": "Search commits", - "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", "tags": [ "search" ], "operationId": "search/commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/search/search#search-commits" + "url": "https://docs.github.com/enterprise-server@3.15/rest/search/search#search-commits" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -52291,7 +59404,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -52363,19 +59476,19 @@ "/search/issues": { "get": { "summary": "Search issues and pull requests", - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.15/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "tags": [ "search" ], "operationId": "search/issues-and-pull-requests", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/search/search#search-issues-and-pull-requests" + "url": "https://docs.github.com/enterprise-server@3.15/rest/search/search#search-issues-and-pull-requests" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -52384,7 +59497,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -52474,14 +59587,14 @@ "/search/labels": { "get": { "summary": "Search labels", - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/labels", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/search/search#search-labels" + "url": "https://docs.github.com/enterprise-server@3.15/rest/search/search#search-labels" }, "parameters": [ { @@ -52495,7 +59608,7 @@ }, { "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query).", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -52504,7 +59617,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -52585,19 +59698,19 @@ "/search/repositories": { "get": { "summary": "Search repositories", - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", "tags": [ "search" ], "operationId": "search/repos", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/search/search#search-repositories" + "url": "https://docs.github.com/enterprise-server@3.15/rest/search/search#search-repositories" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.9/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.15/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -52606,7 +59719,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -52686,19 +59799,19 @@ "/search/topics": { "get": { "summary": "Search topics", - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-server@3.9/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/enterprise-server@3.15/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "tags": [ "search" ], "operationId": "search/topics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/search/search#search-topics" + "url": "https://docs.github.com/enterprise-server@3.15/rest/search/search#search-topics" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query).", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query).", "in": "query", "required": true, "schema": { @@ -52763,19 +59876,19 @@ "/search/users": { "get": { "summary": "Search users", - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search).\"", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/enterprise-server@3.15/graphql/reference/queries#search).\"", "tags": [ "search" ], "operationId": "search/users", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/search/search#search-users" + "url": "https://docs.github.com/enterprise-server@3.15/rest/search/search#search-users" }, "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", "in": "query", "required": true, "schema": { @@ -52784,7 +59897,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results)", "in": "query", "required": false, "schema": { @@ -52860,748 +59973,17 @@ "x-octokit": {} } }, - "/setup/api/configcheck": { - "get": { - "summary": "Get the configuration status", - "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |", - "operationId": "enterprise-admin/get-configuration-status", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-the-configuration-status" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/configuration-status" - }, - "examples": { - "default": { - "$ref": "#/components/examples/configuration-status" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - } - }, - "/setup/api/configure": { - "post": { - "summary": "Start a configuration process", - "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:", - "operationId": "enterprise-admin/start-configuration-process", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "202": { - "description": "Response" - }, - "401": { - "description": "Unauthorized" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - } - }, - "/setup/api/maintenance": { - "get": { - "summary": "Get the maintenance status", - "description": "Check your installation's maintenance status:", - "operationId": "enterprise-admin/get-maintenance-status", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-the-maintenance-status" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/maintenance-status" - }, - "examples": { - "default": { - "$ref": "#/components/examples/maintenance-status" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - }, - "post": { - "summary": "Enable or disable maintenance mode", - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "operationId": "enterprise-admin/enable-or-disable-maintenance-mode", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/maintenance-status" - }, - "examples": { - "default": { - "$ref": "#/components/examples/maintenance-status" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "requestBody": { - "required": true, - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "maintenance": { - "type": "string", - "description": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic)." - } - }, - "required": [ - "maintenance" - ] - }, - "examples": { - "default": { - "value": { - "maintenance": "{\"enabled\":true, \"when\":\"now\"}" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - } - }, - "/setup/api/settings": { - "get": { - "summary": "Get settings", - "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API.", - "operationId": "enterprise-admin/get-settings", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/enterprise-settings" - }, - "examples": { - "default": { - "$ref": "#/components/examples/enterprise-settings" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - }, - "put": { - "summary": "Set settings", - "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", - "operationId": "enterprise-admin/set-settings", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "401": { - "description": "Unauthorized" - } - }, - "requestBody": { - "required": true, - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "settings": { - "type": "string", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings)." - } - }, - "required": [ - "settings" - ] - }, - "examples": { - "204": { - "value": { - "settings": "{ \"enterprise\": { \"public_pages\": true }}" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - } - }, - "/setup/api/settings/authorized-keys": { - "get": { - "summary": "Get all authorized SSH keys", - "description": "", - "operationId": "enterprise-admin/get-all-authorized-ssh-keys", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ssh-key" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/ssh-key-items" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - }, - "post": { - "summary": "Add an authorized SSH key", - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "operationId": "enterprise-admin/add-authorized-ssh-key", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#add-an-authorized-ssh-key" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ssh-key" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/ssh-key-items" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "requestBody": { - "required": true, - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "authorized_key": { - "type": "string", - "description": "The public SSH key." - } - }, - "required": [ - "authorized_key" - ] - }, - "examples": { - "default": { - "value": { - "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - }, - "delete": { - "summary": "Remove an authorized SSH key", - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "operationId": "enterprise-admin/remove-authorized-ssh-key", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ssh-key" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/ssh-key-items" - } - } - } - } - }, - "401": { - "description": "Unauthorized" - } - }, - "requestBody": { - "required": true, - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "authorized_key": { - "type": "string", - "description": "The public SSH key." - } - }, - "required": [ - "authorized_key" - ] - }, - "examples": { - "default": { - "value": { - "authorized_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw==" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - } - }, - "/setup/api/start": { - "post": { - "summary": "Create a GitHub license", - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", - "operationId": "enterprise-admin/create-enterprise-server-license", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#create-a-github-license" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "202": { - "description": "Response" - }, - "401": { - "description": "Unauthorized" - } - }, - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "license": { - "type": "string", - "description": "The content of your _.ghl_ license file." - }, - "password": { - "type": "string", - "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter." - }, - "settings": { - "type": "string", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings)." - } - }, - "required": [ - "license" - ] - }, - "examples": { - "default": { - "value": { - "license": "@enterprise.ghl", - "password": "secret" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - } - }, - "/setup/api/upgrade": { - "post": { - "summary": "Upgrade a license", - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", - "operationId": "enterprise-admin/upgrade-license", - "tags": [ - "enterprise-admin" - ], - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#upgrade-a-license" - }, - "servers": [ - { - "url": "{protocol}://{hostname}", - "variables": { - "hostname": { - "default": "HOSTNAME", - "description": "Self-hosted Enterprise Server hostname" - }, - "protocol": { - "default": "http", - "description": "Self-hosted Enterprise Server protocol" - } - } - } - ], - "responses": { - "202": { - "description": "Response" - }, - "401": { - "description": "Unauthorized" - } - }, - "requestBody": { - "required": false, - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "license": { - "type": "string", - "description": "The content of your new _.ghl_ license file." - } - } - }, - "examples": { - "default": { - "value": { - "license": "@enterprise.ghl" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "enterprise-admin", - "subcategory": "management-console" - }, - "x-octokit": {} - } - }, "/teams/{team_id}": { "get": { "summary": "Get a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-by-name) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#get-a-team-by-name) endpoint.", "tags": [ "teams" ], "operationId": "teams/get-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#get-a-team-legacy" }, "parameters": [ { @@ -53641,14 +60023,14 @@ }, "patch": { "summary": "Update a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", "tags": [ "teams" ], "operationId": "teams/update-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#update-a-team-legacy" }, "parameters": [ { @@ -53678,9 +60060,17 @@ "closed" ] }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, "permission": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", "enum": [ "pull", "push", @@ -53703,7 +60093,8 @@ "value": { "name": "new team name", "description": "new team description", - "privacy": "closed" + "privacy": "closed", + "notification_setting": "notifications_enabled" } } } @@ -53764,14 +60155,14 @@ }, "delete": { "summary": "Delete a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "tags": [ "teams" ], "operationId": "teams/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#delete-a-team-legacy" }, "parameters": [ { @@ -53804,14 +60195,14 @@ "/teams/{team_id}/discussions": { "get": { "summary": "List discussions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions) endpoint.\n\nList all discussions on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions-legacy" }, "parameters": [ { @@ -53865,14 +60256,14 @@ }, "post": { "summary": "Create a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#create-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion-legacy" }, "parameters": [ { @@ -53949,14 +60340,14 @@ "/teams/{team_id}/discussions/{discussion_number}": { "get": { "summary": "Get a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion-legacy" }, "parameters": [ { @@ -53996,14 +60387,14 @@ }, "patch": { "summary": "Update a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#update-a-discussion-legacy" }, "parameters": [ { @@ -54070,14 +60461,14 @@ }, "delete": { "summary": "Delete a discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion-legacy" }, "parameters": [ { @@ -54107,14 +60498,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments": { "get": { "summary": "List discussion comments (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments) endpoint.\n\nList all comments on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/list-discussion-comments-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments-legacy" }, "parameters": [ { @@ -54171,14 +60562,14 @@ }, "post": { "summary": "Create a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/create-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment-legacy" }, "parameters": [ { @@ -54247,14 +60638,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { "get": { "summary": "Get a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/get-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment-legacy" }, "parameters": [ { @@ -54297,14 +60688,14 @@ }, "patch": { "summary": "Update a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/update-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment-legacy" }, "parameters": [ { @@ -54373,14 +60764,14 @@ }, "delete": { "summary": "Delete a discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "teams" ], "operationId": "teams/delete-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment-legacy" }, "parameters": [ { @@ -54413,14 +60804,14 @@ "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { "get": { "summary": "List reactions for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy" }, "parameters": [ { @@ -54434,7 +60825,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "query", "required": false, "schema": { @@ -54496,14 +60887,14 @@ }, "post": { "summary": "Create reaction for a team discussion comment (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-comment-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy" }, "parameters": [ { @@ -54525,7 +60916,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "enum": [ "+1", "-1", @@ -54584,14 +60975,14 @@ "/teams/{team_id}/discussions/{discussion_number}/reactions": { "get": { "summary": "List reactions for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion).\n\nOAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/list-for-team-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy" }, "parameters": [ { @@ -54602,7 +60993,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "query", "required": false, "schema": { @@ -54664,14 +61055,14 @@ }, "post": { "summary": "Create reaction for a team discussion (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion).\n\nA response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\nOAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.", "tags": [ "reactions" ], "operationId": "reactions/create-for-team-discussion-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy" }, "parameters": [ { @@ -54690,7 +61081,7 @@ "properties": { "content": { "type": "string", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion.", "enum": [ "+1", "-1", @@ -54749,14 +61140,14 @@ "/teams/{team_id}/members": { "get": { "summary": "List team members (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.15/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "tags": [ "teams" ], "operationId": "teams/list-members-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#list-team-members-legacy" }, "parameters": [ { @@ -54827,14 +61218,14 @@ "/teams/{team_id}/members/{username}": { "get": { "summary": "Get team member (Legacy)", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ "teams" ], "operationId": "teams/get-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-member-legacy" }, "parameters": [ { @@ -54865,14 +61256,14 @@ }, "put": { "summary": "Add team member (Legacy)", - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-team-member-legacy" }, "parameters": [ { @@ -54909,14 +61300,14 @@ }, "delete": { "summary": "Remove team member (Legacy)", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-member-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-member-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-member-legacy" }, "parameters": [ { @@ -54949,14 +61340,14 @@ "/teams/{team_id}/memberships/{username}": { "get": { "summary": "Get team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team).", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#create-a-team).", "tags": [ "teams" ], "operationId": "teams/get-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -54999,14 +61390,14 @@ }, "put": { "summary": "Add or update team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "tags": [ "teams" ], "operationId": "teams/add-or-update-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -55084,14 +61475,14 @@ }, "delete": { "summary": "Remove team membership for a user (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "tags": [ "teams" ], "operationId": "teams/remove-membership-for-user-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user-legacy" }, "parameters": [ { @@ -55124,14 +61515,14 @@ "/teams/{team_id}/projects": { "get": { "summary": "List team projects (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "tags": [ "teams" ], "operationId": "teams/list-projects-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects-legacy" }, "parameters": [ { @@ -55187,14 +61578,14 @@ "/teams/{team_id}/projects/{project_id}": { "get": { "summary": "Check team permissions for a project (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-project-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project-legacy" }, "parameters": [ { @@ -55237,14 +61628,14 @@ }, "put": { "summary": "Add or update team project permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", "tags": [ "teams" ], "operationId": "teams/add-or-update-project-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions-legacy" }, "parameters": [ { @@ -55263,7 +61654,7 @@ "properties": { "permission": { "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "enum": [ "read", "write", @@ -55306,7 +61697,7 @@ "response-if-the-project-is-not-owned-by-the-organization": { "value": { "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions" + "documentation_url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions" } } } @@ -55333,14 +61724,14 @@ }, "delete": { "summary": "Remove a project from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", "tags": [ "teams" ], "operationId": "teams/remove-project-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team-legacy" }, "parameters": [ { @@ -55376,14 +61767,14 @@ "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -55439,14 +61830,14 @@ "/teams/{team_id}/repos/{owner}/{repo}": { "get": { "summary": "Check team permissions for a repository (Legacy)", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `Accept` header:", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", "tags": [ "teams" ], "operationId": "teams/check-permissions-for-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-repository-legacy" }, "parameters": [ { @@ -55495,14 +61886,14 @@ }, "put": { "summary": "Add or update team repository permissions (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "teams" ], "operationId": "teams/add-or-update-repo-permissions-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-repository-permissions-legacy" }, "parameters": [ { @@ -55568,14 +61959,14 @@ }, "delete": { "summary": "Remove a repository from a team (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "tags": [ "teams" ], "operationId": "teams/remove-repo-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-repository-from-a-team-legacy" }, "parameters": [ { @@ -55608,14 +61999,14 @@ "/teams/{team_id}/teams": { "get": { "summary": "List child teams (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams) endpoint.", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-child-teams) endpoint.", "tags": [ "teams" ], "operationId": "teams/list-child-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams-legacy" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-child-teams-legacy" }, "parameters": [ { @@ -55684,7 +62075,7 @@ "operationId": "users/get-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/users#get-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/users#get-the-authenticated-user" }, "parameters": [], "responses": { @@ -55700,7 +62091,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "response-with-public-and-private-profile-information": { @@ -55740,7 +62138,7 @@ "operationId": "users/update-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/users#update-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/users#update-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -55854,7 +62252,7 @@ "operationId": "packages/list-docker-migration-conflicting-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" }, "responses": { "200": { @@ -55895,7 +62293,7 @@ "operationId": "users/list-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/emails#list-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/emails#list-email-addresses-for-the-authenticated-user" }, "parameters": [ { @@ -55969,7 +62367,7 @@ "operationId": "users/add-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/emails#add-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/emails#add-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -55986,9 +62384,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 + "example": "username@example.com" }, + "minItems": 1, "example": [] } }, @@ -56081,7 +62479,7 @@ "operationId": "users/delete-email-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/emails#delete-an-email-address-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/emails#delete-an-email-address-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -56098,9 +62496,9 @@ "type": "array", "items": { "type": "string", - "example": "username@example.com", - "minItems": 1 - } + "example": "username@example.com" + }, + "minItems": 1 } }, "example": { @@ -56178,7 +62576,7 @@ "operationId": "users/list-followers-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#list-followers-of-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#list-followers-of-the-authenticated-user" }, "parameters": [ { @@ -56241,7 +62639,7 @@ "operationId": "users/list-followed-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#list-the-people-the-authenticated-user-follows" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#list-the-people-the-authenticated-user-follows" }, "parameters": [ { @@ -56314,7 +62712,7 @@ "operationId": "users/check-person-is-followed-by-authenticated", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" }, "parameters": [ { @@ -56355,14 +62753,14 @@ }, "put": { "summary": "Follow a user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/follow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#follow-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#follow-a-user" }, "parameters": [ { @@ -56384,6 +62782,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -56403,7 +62804,7 @@ "operationId": "users/unfollow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#unfollow-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#unfollow-a-user" }, "parameters": [ { @@ -56446,7 +62847,7 @@ "operationId": "users/list-gpg-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" }, "parameters": [ { @@ -56520,7 +62921,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -56615,7 +63016,7 @@ "operationId": "users/get-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -56678,7 +63079,7 @@ "operationId": "users/delete-gpg-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" }, "parameters": [ { @@ -56734,7 +63135,7 @@ "operationId": "apps/list-installations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" }, "parameters": [ { @@ -56809,7 +63210,7 @@ "operationId": "apps/list-installation-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" }, "parameters": [ { @@ -56883,14 +63284,14 @@ "/user/installations/{installation_id}/repositories/{repository_id}": { "put": { "summary": "Add a repository to an app installation", - "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], "operationId": "apps/add-repo-to-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/installations#add-a-repository-to-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/installations#add-a-repository-to-an-app-installation" }, "parameters": [ { @@ -56934,14 +63335,14 @@ }, "delete": { "summary": "Remove a repository from an app installation", - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. \n\nThis endpoint only works for PATs (classic) with the `repo` scope.", "tags": [ "apps" ], "operationId": "apps/remove-repo-from-installation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/installations#remove-a-repository-from-an-app-installation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/installations#remove-a-repository-from-an-app-installation" }, "parameters": [ { @@ -56963,6 +63364,9 @@ }, "404": { "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization." } }, "x-github": { @@ -56987,14 +63391,14 @@ "/user/issues": { "get": { "summary": "List user account issues assigned to the authenticated user", - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "issues" ], "operationId": "issues/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" }, "parameters": [ { @@ -57111,7 +63515,7 @@ "operationId": "users/list-public-ssh-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" }, "parameters": [ { @@ -57185,7 +63589,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -57282,7 +63686,7 @@ "operationId": "users/get-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -57345,7 +63749,7 @@ "operationId": "users/delete-public-ssh-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" }, "parameters": [ { @@ -57398,7 +63802,7 @@ "operationId": "orgs/list-memberships-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" }, "parameters": [ { @@ -57477,7 +63881,7 @@ "operationId": "orgs/get-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -57524,7 +63928,7 @@ "operationId": "orgs/update-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -57605,7 +64009,7 @@ "operationId": "migrations/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/users#list-user-migrations" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/users#list-user-migrations" }, "parameters": [ { @@ -57666,7 +64070,7 @@ "operationId": "migrations/start-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/users#start-a-user-migration" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/users#start-a-user-migration" }, "parameters": [], "requestBody": { @@ -57808,7 +64212,7 @@ "operationId": "migrations/get-archive-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/users#download-a-user-migration-archive" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/users#download-a-user-migration-archive" }, "parameters": [ { @@ -57848,7 +64252,7 @@ "operationId": "migrations/list-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/migrations/users#list-repositories-for-a-user-migration" + "url": "https://docs.github.com/enterprise-server@3.15/rest/migrations/users#list-repositories-for-a-user-migration" }, "parameters": [ { @@ -57911,14 +64315,14 @@ "/user/orgs": { "get": { "summary": "List organizations for the authenticated user", - "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.", "tags": [ "orgs" ], "operationId": "orgs/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#list-organizations-for-the-authenticated-user" }, "parameters": [ { @@ -57974,14 +64378,14 @@ "/user/packages": { "get": { "summary": "List packages for the authenticated user's namespace", - "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" }, "parameters": [ { @@ -58046,14 +64450,14 @@ "/user/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for the authenticated user", - "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -58090,14 +64494,14 @@ }, "delete": { "summary": "Delete a package for the authenticated user", - "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#delete-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -58133,14 +64537,14 @@ "/user/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for the authenticated user", - "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-a-package-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#restore-a-package-for-the-authenticated-user" }, "parameters": [ { @@ -58185,14 +64589,14 @@ "/user/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by the authenticated user", - "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { @@ -58273,14 +64677,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for the authenticated user", - "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -58320,14 +64724,14 @@ }, "delete": { "summary": "Delete a package version for the authenticated user", - "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -58366,14 +64770,14 @@ "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore a package version for the authenticated user", - "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" }, "parameters": [ { @@ -58419,7 +64823,7 @@ "operationId": "projects/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#create-a-user-project" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#create-a-user-project" }, "parameters": [], "requestBody": { @@ -58498,14 +64902,14 @@ "/user/public_emails": { "get": { "summary": "List public email addresses for the authenticated user", - "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", "tags": [ "users" ], "operationId": "users/list-public-emails-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" }, "parameters": [ { @@ -58581,7 +64985,7 @@ "operationId": "repos/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repositories-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repositories-for-the-authenticated-user" }, "parameters": [ { @@ -58717,7 +65121,7 @@ "operationId": "repos/create-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -58823,7 +65227,7 @@ "PR_TITLE", "COMMIT_OR_PR_TITLE" ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." }, "squash_merge_commit_message": { "type": "string", @@ -58840,7 +65244,7 @@ "PR_TITLE", "MERGE_MESSAGE" ], - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", @@ -58945,7 +65349,7 @@ "operationId": "repos/list-invitations-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" }, "parameters": [ { @@ -59011,7 +65415,7 @@ "operationId": "repos/accept-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#accept-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/invitations#accept-a-repository-invitation" }, "parameters": [ { @@ -59062,7 +65466,7 @@ "operationId": "repos/decline-invitation-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#decline-a-repository-invitation" + "url": "https://docs.github.com/enterprise-server@3.15/rest/collaborators/invitations#decline-a-repository-invitation" }, "parameters": [ { @@ -59115,7 +65519,7 @@ "operationId": "users/list-social-accounts-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" }, "parameters": [ { @@ -59179,7 +65583,7 @@ "operationId": "users/add-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -59275,7 +65679,7 @@ "operationId": "users/delete-social-account-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -59358,7 +65762,7 @@ "operationId": "users/list-ssh-signing-keys-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" }, "parameters": [ { @@ -59423,7 +65827,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" }, "parameters": [], "requestBody": { @@ -59438,7 +65842,7 @@ "example": "Personal MacBook Air" }, "key": { - "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.9/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.15/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", "type": "string", "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " } @@ -59510,7 +65914,7 @@ "operationId": "users/get-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -59563,7 +65967,7 @@ "operationId": "users/delete-ssh-signing-key-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" }, "parameters": [ { @@ -59599,14 +66003,14 @@ "/user/starred": { "get": { "summary": "List repositories starred by the authenticated user", - "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" }, "parameters": [ { @@ -59688,7 +66092,7 @@ "operationId": "activity/check-repo-is-starred-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" }, "parameters": [ { @@ -59732,14 +66136,14 @@ }, "put": { "summary": "Star a repository for the authenticated user", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "tags": [ "activity" ], "operationId": "activity/star-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/starring#star-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/starring#star-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -59783,7 +66187,7 @@ "operationId": "activity/unstar-repo-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" }, "parameters": [ { @@ -59829,7 +66233,7 @@ "operationId": "activity/list-watched-repos-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" }, "parameters": [ { @@ -59892,7 +66296,7 @@ "operationId": "teams/list-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-teams-for-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-teams-for-the-authenticated-user" }, "parameters": [ { @@ -59945,81 +66349,21 @@ "x-octokit": {} } }, - "/users": { + "/user/{account_id}": { "get": { - "summary": "List users", - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.15/rest/users/emails)\".", "tags": [ "users" ], - "operationId": "users/list", + "operationId": "users/get-by-id", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/users#list-users" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/users#get-a-user-using-their-id" }, "parameters": [ { - "$ref": "#/components/parameters/since-user" - }, - { - "$ref": "#/components/parameters/per-page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/simple-user-items" - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "users", - "subcategory": "users" - }, - "x-octokit": {} - } - }, - "/users/{username}": { - "get": { - "summary": "Get a user", - "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.9/rest/users/emails)\".", - "tags": [ - "users" - ], - "operationId": "users/get-by-username", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/users#get-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/account-id" } ], "responses": { @@ -60035,7 +66379,14 @@ { "$ref": "#/components/schemas/public-user" } - ] + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } }, "examples": { "default-response": { @@ -60061,238 +66412,361 @@ "x-octokit": {} } }, - "/users/{username}/docker/conflicts": { - "get": { - "summary": "Get list of conflicting packages during Docker migration for user", - "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", - "tags": [ - "packages" - ], - "operationId": "packages/list-docker-migration-conflicting-packages-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/package" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/packages-for-user" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "packages", - "subcategory": "packages" - }, - "x-octokit": {} - } - }, - "/users/{username}/events": { - "get": { - "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", - "tags": [ - "activity" - ], - "operationId": "activity/list-events-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-events-for-the-authenticated-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/event" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/user-events-items" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "activity", - "subcategory": "events" - }, - "x-octokit": {} - } - }, - "/users/{username}/events/orgs/{org}": { - "get": { - "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", - "tags": [ - "activity" - ], - "operationId": "activity/list-org-events-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-organization-events-for-the-authenticated-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/username" - }, - { - "$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/event" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/user-org-events-items" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "category": "activity", - "subcategory": "events" - }, - "x-octokit": {} - } - }, - "/users/{username}/events/public": { - "get": { - "summary": "List public events for a user", - "description": "", - "tags": [ - "activity" - ], - "operationId": "activity/list-public-events-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-events-for-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/event" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/user-public-events-items" - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "activity", - "subcategory": "events" - }, - "x-octokit": {} - } - }, - "/users/{username}/followers": { + "/users": { "get": { - "summary": "List followers of a user", - "description": "Lists the people following the specified user.", + "summary": "List users", + "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", "tags": [ "users" ], - "operationId": "users/list-followers-for-user", + "operationId": "users/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#list-followers-of-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/users#list-users" }, "parameters": [ { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/since-user" }, { "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + }, + "x-octokit": {} + } + }, + "/users/{username}": { + "get": { + "summary": "Get a user", + "description": "Provides publicly available information about someone with a GitHub account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/enterprise-server@3.15/rest/users/emails)\".", + "tags": [ + "users" + ], + "operationId": "users/get-by-username", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/users#get-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + }, + "x-octokit": {} + } + }, + "/users/{username}/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for user", + "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-for-user" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + }, + "x-octokit": {} + } + }, + "/users/{username}/events": { + "get": { + "summary": "List events for the authenticated user", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-events-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-events-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/events/orgs/{org}": { + "get": { + "summary": "List organization events for the authenticated user", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-org-events-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-organization-events-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$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/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-org-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/events/public": { + "get": { + "summary": "List public events for a user", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-events-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-public-events-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-public-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + }, + "x-octokit": {} + } + }, + "/users/{username}/followers": { + "get": { + "summary": "List followers of a user", + "description": "Lists the people following the specified user.", + "tags": [ + "users" + ], + "operationId": "users/list-followers-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#list-followers-of-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -60339,7 +66813,7 @@ "operationId": "users/list-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#list-the-people-a-user-follows" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#list-the-people-a-user-follows" }, "parameters": [ { @@ -60396,7 +66870,7 @@ "operationId": "users/check-following-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/followers#check-if-a-user-follows-another-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/followers#check-if-a-user-follows-another-user" }, "parameters": [ { @@ -60438,7 +66912,7 @@ "operationId": "gists/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/gists/gists#list-gists-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/gists/gists#list-gists-for-a-user" }, "parameters": [ { @@ -60501,7 +66975,7 @@ "operationId": "users/list-gpg-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#list-gpg-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/gpg-keys#list-gpg-keys-for-a-user" }, "parameters": [ { @@ -60558,7 +67032,7 @@ "operationId": "users/get-context-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/users#get-contextual-information-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/users#get-contextual-information-for-a-user" }, "parameters": [ { @@ -60624,14 +67098,14 @@ "/users/{username}/installation": { "get": { "summary": "Get a user installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "tags": [ "apps" ], "operationId": "apps/get-user-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" + "url": "https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" }, "parameters": [ { @@ -60674,7 +67148,7 @@ "operationId": "users/list-public-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/keys#list-public-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/keys#list-public-keys-for-a-user" }, "parameters": [ { @@ -60724,14 +67198,14 @@ "/users/{username}/orgs": { "get": { "summary": "List organizations for a user", - "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.15/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", "tags": [ "orgs" ], "operationId": "orgs/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#list-organizations-for-a-user" }, "parameters": [ { @@ -60781,14 +67255,14 @@ "/users/{username}/packages": { "get": { "summary": "List packages for a user", - "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/list-packages-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-packages-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#list-packages-for-a-user" }, "parameters": [ { @@ -60862,14 +67336,14 @@ "/users/{username}/packages/{package_type}/{package_name}": { "get": { "summary": "Get a package for a user", - "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-a-package-for-a-user" }, "parameters": [ { @@ -60909,14 +67383,14 @@ }, "delete": { "summary": "Delete a package for a user", - "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#delete-a-package-for-a-user" }, "parameters": [ { @@ -60955,14 +67429,14 @@ "/users/{username}/packages/{package_type}/{package_name}/restore": { "post": { "summary": "Restore a package for a user", - "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-a-package-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#restore-a-package-for-a-user" }, "parameters": [ { @@ -61010,14 +67484,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { "summary": "List package versions for a package owned by a user", - "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" }, "parameters": [ { @@ -61071,14 +67545,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { "get": { "summary": "Get a package version for a user", - "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/get-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#get-a-package-version-for-a-user" }, "parameters": [ { @@ -61121,14 +67595,14 @@ }, "delete": { "summary": "Delete package version for a user", - "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/delete-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#delete-package-version-for-a-user" }, "parameters": [ { @@ -61170,14 +67644,14 @@ "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { "post": { "summary": "Restore package version for a user", - "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", "tags": [ "packages" ], "operationId": "packages/restore-package-version-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-package-version-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/packages/packages#restore-package-version-for-a-user" }, "parameters": [ { @@ -61226,7 +67700,7 @@ "operationId": "projects/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/projects/projects#list-user-projects" + "url": "https://docs.github.com/enterprise-server@3.15/rest/projects/projects#list-user-projects" }, "parameters": [ { @@ -61294,14 +67768,14 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-received-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-events-received-by-the-authenticated-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-events-received-by-the-authenticated-user" }, "parameters": [ { @@ -61346,14 +67820,14 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], "operationId": "activity/list-received-public-events-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-public-events-received-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/events#list-public-events-received-by-a-user" }, "parameters": [ { @@ -61405,7 +67879,7 @@ "operationId": "repos/list-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repositories-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repositories-for-a-user" }, "parameters": [ { @@ -61499,14 +67973,14 @@ "/users/{username}/site_admin": { "put": { "summary": "Promote a user to be a site administrator", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "operationId": "enterprise-admin/promote-user-to-be-site-administrator", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator" }, "parameters": [ { @@ -61535,7 +68009,7 @@ ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#demote-a-site-administrator" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#demote-a-site-administrator" }, "parameters": [ { @@ -61566,7 +68040,7 @@ "operationId": "users/list-social-accounts-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/social-accounts#list-social-accounts-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/social-accounts#list-social-accounts-for-a-user" }, "parameters": [ { @@ -61623,7 +68097,7 @@ "operationId": "users/list-ssh-signing-keys-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" }, "parameters": [ { @@ -61673,14 +68147,14 @@ "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", - "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", "tags": [ "activity" ], "operationId": "activity/list-repos-starred-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/starring#list-repositories-starred-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/starring#list-repositories-starred-by-a-user" }, "parameters": [ { @@ -61753,7 +68227,7 @@ "operationId": "activity/list-repos-watched-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/activity/watching#list-repositories-watched-by-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/activity/watching#list-repositories-watched-by-a-user" }, "parameters": [ { @@ -61803,14 +68277,14 @@ "/users/{username}/suspended": { "put": { "summary": "Suspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method).\"", "operationId": "enterprise-admin/suspend-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#suspend-a-user" }, "parameters": [ { @@ -61832,7 +68306,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } }, @@ -61856,14 +68330,14 @@ }, "delete": { "summary": "Unsuspend a user", - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", "operationId": "enterprise-admin/unsuspend-user", "tags": [ "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#unsuspend-a-user" + "url": "https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#unsuspend-a-user" }, "parameters": [ { @@ -61884,7 +68358,7 @@ "properties": { "reason": { "type": "string", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." } } }, @@ -61917,7 +68391,7 @@ "operationId": "meta/get-zen", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-server@3.9/rest/meta/meta#get-the-zen-of-github" + "url": "https://docs.github.com/enterprise-server@3.15/rest/meta/meta#get-the-zen-of-github" }, "responses": { "200": { @@ -62023,13 +68497,1349 @@ } }, "x-webhooks": { + "branch-protection-configuration-disabled": { + "post": { + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection)\" 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": "All branch protections were disabled for a repository.", + "operationId": "branch-protection-configuration/disabled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#branch_protection_configuration" + }, + "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-branch-protection-configuration-disabled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-configuration-enabled": { + "post": { + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection)\" 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": "All branch protections were enabled for a repository.", + "operationId": "branch-protection-configuration/enabled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#branch_protection_configuration" + }, + "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-branch-protection-configuration-enabled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "branch-protection-rule-created": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)\" 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 branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection)\" 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 branch protection rule was created.", "operationId": "branch-protection-rule/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-rule-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection)\" 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 branch protection rule was deleted.", + "operationId": "branch-protection-rule/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-rule-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-edited": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection)\" 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 branch protection rule was edited.", + "operationId": "branch-protection-rule/edited", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-rule-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-cancelled": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was cancelled.", + "operationId": "exemption-request-secret-scanning/cancelled", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "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-exemption-request-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-completed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning bypass request was completed.", + "operationId": "exemption-request-secret-scanning/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "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-exemption-request-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-created": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass request was created.", + "operationId": "exemption-request-secret-scanning/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "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-exemption-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-response-dismissed": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A secret scanning push protection bypass response was dismissed.", + "operationId": "exemption-request-secret-scanning/response-dismissed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "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-exemption-request-response-dismissed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "bypass-request-secret-scanning-response-submitted": { + "post": { + "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", + "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", + "operationId": "exemption-request-secret-scanning/response-submitted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" + }, + "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-exemption-request-response-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": true, + "category": "webhooks", + "subcategory": "bypass_request_secret_scanning", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "cache-sync": { + "post": { + "summary": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"[About repository caching](https://docs.github.com/enterprise-server@3.15/admin/enterprise-management/caching-repositories/about-repository-caching).\"", + "operationId": "cache-sync", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#cache_sync" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-cache-sync" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "cache_sync", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.15/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#check_run" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-created": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.15/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", + "operationId": "check-run/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#check_run" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-requested-action": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.15/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.15/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -62110,7 +69920,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-branch-protection-rule-created" + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } } } } @@ -62122,8 +69947,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -62132,13 +69958,13 @@ } } }, - "branch-protection-rule-deleted": { + "check-run-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)\" 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 branch protection rule was deleted.", - "operationId": "branch-protection-rule/deleted", + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.15/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { @@ -62219,7 +70045,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-branch-protection-rule-deleted" + "$ref": "#/components/schemas/webhook-check-run-rerequested" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested-form-encoded" + } } } } @@ -62231,8 +70072,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "check_run", "supported-webhook-types": [ "repository", "organization", @@ -62241,13 +70083,13 @@ } } }, - "branch-protection-rule-edited": { + "check-suite-completed": { "post": { - "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)\" 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 branch protection rule was edited.", - "operationId": "branch-protection-rule/edited", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.15/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -62328,7 +70170,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-branch-protection-rule-edited" + "$ref": "#/components/schemas/webhook-check-suite-completed" } } } @@ -62341,7 +70183,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "branch_protection_rule", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -62350,12 +70192,13 @@ } } }, - "cache-sync": { + "check-suite-requested": { "post": { - "summary": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"[About repository caching](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/caching-repositories/about-repository-caching).\"", - "operationId": "cache-sync", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.15/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.15/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.15/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#cache_sync" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -62436,7 +70279,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-cache-sync" + "$ref": "#/components/schemas/webhook-check-suite-requested" } } } @@ -62449,7 +70292,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "cache_sync", + "subcategory": "check_suite", "supported-webhook-types": [ "repository", "organization", @@ -62458,13 +70301,13 @@ } } }, - "check-run-completed": { + "check-suite-rerequested": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A check run was completed, and a conclusion is available.", - "operationId": "check-run/completed", + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.15/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.15/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { @@ -62545,22 +70388,116 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed" - } + "$ref": "#/components/schemas/webhook-check-suite-rerequested" } - }, - "application/x-www-form-urlencoded": { + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check_suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-appeared-in-branch": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.15/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-completed-form-encoded" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" } } } @@ -62572,9 +70509,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -62583,13 +70519,13 @@ } } }, - "check-run-created": { + "code-scanning-alert-closed-by-user": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A new check run was created.", - "operationId": "check-run/created", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.15/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -62670,22 +70606,116 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" } - }, - "application/x-www-form-urlencoded": { + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-created": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.15/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" } } } @@ -62697,9 +70727,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -62708,13 +70737,13 @@ } } }, - "check-run-requested-action": { + "code-scanning-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.9/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", - "operationId": "check-run/requested-action", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.15/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -62795,22 +70824,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-requested-action-form-encoded" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" } } } @@ -62822,9 +70836,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -62833,13 +70846,13 @@ } } }, - "check-run-rerequested": { + "code-scanning-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check run was 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": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", - "operationId": "check-run/rerequested", + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.15/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { @@ -62920,22 +70933,116 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" } - }, - "application/x-www-form-urlencoded": { + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-reopened-by-user": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.15/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/check-run-rerequested-form-encoded" - } + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" } } } @@ -62947,9 +71054,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "check_run", + "subcategory": "code_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -62958,13 +71064,13 @@ } } }, - "check-suite-completed": { + "commit-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "All check runs in a check suite have completed, and a conclusion is available.", - "operationId": "check-suite/completed", + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.15/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { @@ -63045,7 +71151,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-completed" + "$ref": "#/components/schemas/webhook-commit-comment-created" } } } @@ -63058,7 +71164,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "commit_comment", "supported-webhook-types": [ "repository", "organization", @@ -63067,13 +71173,12 @@ } } }, - "check-suite-requested": { + "create": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.9/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", - "operationId": "check-suite/requested", + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { @@ -63154,7 +71259,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-create" } } } @@ -63167,7 +71272,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "create", "supported-webhook-types": [ "repository", "organization", @@ -63176,13 +71281,12 @@ } } }, - "check-suite-rerequested": { + "delete": { "post": { - "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n**Note**: The API only looks for pushes in the repository where the check suite was 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": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.9/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", - "operationId": "check-suite/rerequested", + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { @@ -63263,7 +71367,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-delete" } } } @@ -63276,7 +71380,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "check_suite", + "subcategory": "delete", "supported-webhook-types": [ "repository", "organization", @@ -63285,13 +71389,13 @@ } } }, - "code-scanning-alert-appeared-in-branch": { + "dependabot-alert-auto-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", - "operationId": "code-scanning-alert/appeared-in-branch", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -63372,7 +71476,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" } } } @@ -63385,7 +71489,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -63394,13 +71498,13 @@ } } }, - "code-scanning-alert-closed-by-user": { + "dependabot-alert-auto-reopened": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone closed a code scanning alert.", - "operationId": "code-scanning-alert/closed-by-user", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -63481,7 +71585,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" } } } @@ -63494,7 +71598,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -63503,13 +71607,13 @@ } } }, - "code-scanning-alert-created": { + "dependabot-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was created in a repository.", - "operationId": "code-scanning-alert/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -63590,7 +71694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" } } } @@ -63603,7 +71707,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -63612,13 +71716,13 @@ } } }, - "code-scanning-alert-fixed": { + "dependabot-alert-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A code scanning alert was fixed in a branch by a commit.", - "operationId": "code-scanning-alert/fixed", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -63699,7 +71803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" } } } @@ -63712,7 +71816,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -63721,13 +71825,13 @@ } } }, - "code-scanning-alert-reopened": { + "dependabot-alert-fixed": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "A previously fixed code scanning alert reappeared in a branch.", - "operationId": "code-scanning-alert/reopened", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -63808,7 +71912,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" } } } @@ -63821,7 +71925,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -63830,13 +71934,13 @@ } } }, - "code-scanning-alert-reopened-by-user": { + "dependabot-alert-reintroduced": { "post": { - "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", - "description": "Someone reopened a code scanning alert.", - "operationId": "code-scanning-alert/reopened-by-user", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -63917,7 +72021,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" } } } @@ -63930,7 +72034,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "code_scanning_alert", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -63939,13 +72043,13 @@ } } }, - "commit-comment-created": { + "dependabot-alert-reopened": { "post": { - "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-server@3.9/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "Someone commented on a commit.", - "operationId": "commit-comment/created", + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n> [!NOTE]\n> Webhook events for Dependabot alerts are currently in public preview and subject to change.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#commit_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { @@ -64026,7 +72130,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" } } } @@ -64039,7 +72143,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "commit_comment", + "subcategory": "dependabot_alert", "supported-webhook-types": [ "repository", "organization", @@ -64048,12 +72152,13 @@ } } }, - "create": { + "deploy-key-created": { "post": { - "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", - "operationId": "create", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.15/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.15/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#create" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -64134,7 +72239,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-deploy-key-created" } } } @@ -64147,7 +72252,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "create", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -64156,12 +72261,13 @@ } } }, - "delete": { + "deploy-key-deleted": { "post": { - "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: This event will not occur when more than three tags are deleted at once.", - "operationId": "delete", + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.15/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.15/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#delete" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { @@ -64242,7 +72348,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-deploy-key-deleted" } } } @@ -64255,7 +72361,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "delete", + "subcategory": "deploy_key", "supported-webhook-types": [ "repository", "organization", @@ -64264,13 +72370,13 @@ } } }, - "dependabot-alert-created": { + "deployment-created": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", - "operationId": "dependabot-alert/created", + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.15/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { @@ -64351,7 +72457,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-deployment-created" } } } @@ -64364,7 +72470,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment", "supported-webhook-types": [ "repository", "organization", @@ -64373,13 +72479,13 @@ } } }, - "dependabot-alert-dismissed": { + "deployment-protection-rule-requested": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually closed.", - "operationId": "dependabot-alert/dismissed", + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-server@3.15/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { @@ -64460,7 +72566,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } @@ -64473,22 +72579,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_protection_rule", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "dependabot-alert-fixed": { + "deployment-review-approved": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change removed a vulnerability.", - "operationId": "dependabot-alert/fixed", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.15/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -64569,7 +72673,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-deployment-review-approved" } } } @@ -64582,22 +72686,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "dependabot-alert-reintroduced": { + "deployment-review-rejected": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", - "operationId": "dependabot-alert/reintroduced", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.15/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -64678,7 +72780,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-deployment-review-rejected" } } } @@ -64691,22 +72793,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "dependabot-alert-reopened": { + "deployment-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.", - "description": "A Dependabot alert was manually reopened.", - "operationId": "dependabot-alert/reopened", + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.15/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { @@ -64787,7 +72887,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-deployment-review-requested" } } } @@ -64800,22 +72900,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "dependabot_alert", + "subcategory": "deployment_review", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "deploy-key-created": { + "deployment-status-created": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.9/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was created.", - "operationId": "deploy-key/created", + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.15/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#deployment_status" }, "parameters": [ { @@ -64896,7 +72994,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-deployment-status-created" } } } @@ -64909,7 +73007,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "deployment_status", "supported-webhook-types": [ "repository", "organization", @@ -64918,13 +73016,13 @@ } } }, - "deploy-key-deleted": { + "discussion-answered": { "post": { - "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-server@3.9/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deploy key was deleted.", - "operationId": "deploy-key/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deploy_key" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -65005,7 +73103,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-discussion-answered" } } } @@ -65018,7 +73116,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deploy_key", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -65027,13 +73125,13 @@ } } }, - "deployment-created": { + "discussion-category-changed": { "post": { - "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment was created.", - "operationId": "deployment/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -65114,7 +73212,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-discussion-category-changed" } } } @@ -65127,7 +73225,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -65136,13 +73234,13 @@ } } }, - "deployment-review-approved": { + "discussion-closed": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was approved.", - "operationId": "deployment-review/approved", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was closed.", + "operationId": "discussion/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -65164,7 +73262,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -65204,7 +73302,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.1.9", + "example": "3.9.0", "schema": { "type": "string" } @@ -65223,7 +73321,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-approved" + "$ref": "#/components/schemas/webhook-discussion-closed" } } } @@ -65236,20 +73334,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-rejected": { + "discussion-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was rejected.", - "operationId": "deployment-review/rejected", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -65330,7 +73430,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-rejected" + "$ref": "#/components/schemas/webhook-discussion-comment-created" } } } @@ -65343,20 +73443,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-review-requested": { + "discussion-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A deployment review was requested.", - "operationId": "deployment-review/requested", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -65437,7 +73539,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-review-requested" + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" } } } @@ -65450,20 +73552,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_review", + "subcategory": "discussion_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "deployment-status-created": { + "discussion-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", - "description": "A new deployment status was created.", - "operationId": "deployment-status/created", + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_status" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { @@ -65544,7 +73648,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-deployment-status-created" + "$ref": "#/components/schemas/webhook-discussion-comment-edited" } } } @@ -65557,7 +73661,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "deployment_status", + "subcategory": "discussion_comment", "supported-webhook-types": [ "repository", "organization", @@ -65566,13 +73670,13 @@ } } }, - "discussion-answered": { + "discussion-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was marked as the answer.", - "operationId": "discussion/answered", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was created.", + "operationId": "discussion/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -65653,7 +73757,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-answered" + "$ref": "#/components/schemas/webhook-discussion-created" } } } @@ -65675,13 +73779,13 @@ } } }, - "discussion-category-changed": { + "discussion-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The category of a discussion was changed.", - "operationId": "discussion/category-changed", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -65762,7 +73866,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-category-changed" + "$ref": "#/components/schemas/webhook-discussion-deleted" } } } @@ -65784,13 +73888,13 @@ } } }, - "discussion-closed": { + "discussion-edited": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was closed.", - "operationId": "discussion/closed", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -65812,7 +73916,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -65852,7 +73956,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.9.0", + "example": "3.1.9", "schema": { "type": "string" } @@ -65871,7 +73975,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-closed" + "$ref": "#/components/schemas/webhook-discussion-edited" } } } @@ -65893,13 +73997,13 @@ } } }, - "discussion-comment-created": { + "discussion-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was created.", - "operationId": "discussion-comment/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -65980,7 +74084,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-created" + "$ref": "#/components/schemas/webhook-discussion-labeled" } } } @@ -65993,7 +74097,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -66002,13 +74106,13 @@ } } }, - "discussion-comment-deleted": { + "discussion-locked": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was deleted.", - "operationId": "discussion-comment/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was locked.", + "operationId": "discussion/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66089,7 +74193,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + "$ref": "#/components/schemas/webhook-discussion-locked" } } } @@ -66102,7 +74206,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -66111,13 +74215,13 @@ } } }, - "discussion-comment-edited": { + "discussion-pinned": { "post": { - "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on a discussion was edited.", - "operationId": "discussion-comment/edited", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66198,7 +74302,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-comment-edited" + "$ref": "#/components/schemas/webhook-discussion-pinned" } } } @@ -66211,7 +74315,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion_comment", + "subcategory": "discussion", "supported-webhook-types": [ "repository", "organization", @@ -66220,13 +74324,13 @@ } } }, - "discussion-created": { + "discussion-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was created.", - "operationId": "discussion/created", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66248,7 +74352,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "discussions", "schema": { "type": "string" } @@ -66288,7 +74392,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.1.9", + "example": "3.9.0", "schema": { "type": "string" } @@ -66307,7 +74411,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-created" + "$ref": "#/components/schemas/webhook-discussion-reopened" } } } @@ -66329,13 +74433,13 @@ } } }, - "discussion-deleted": { + "discussion-transferred": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was deleted.", - "operationId": "discussion/deleted", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66416,7 +74520,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-deleted" + "$ref": "#/components/schemas/webhook-discussion-transferred" } } } @@ -66438,13 +74542,13 @@ } } }, - "discussion-edited": { + "discussion-unanswered": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", - "operationId": "discussion/edited", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66525,7 +74629,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-edited" + "$ref": "#/components/schemas/webhook-discussion-unanswered" } } } @@ -66547,13 +74651,13 @@ } } }, - "discussion-labeled": { + "discussion-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was added to a discussion.", - "operationId": "discussion/labeled", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66634,7 +74738,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-labeled" + "$ref": "#/components/schemas/webhook-discussion-unlabeled" } } } @@ -66656,13 +74760,13 @@ } } }, - "discussion-locked": { + "discussion-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was locked.", - "operationId": "discussion/locked", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66743,7 +74847,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-locked" + "$ref": "#/components/schemas/webhook-discussion-unlocked" } } } @@ -66765,13 +74869,13 @@ } } }, - "discussion-pinned": { + "discussion-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was pinned.", - "operationId": "discussion/pinned", + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.15/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { @@ -66852,7 +74956,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-pinned" + "$ref": "#/components/schemas/webhook-discussion-unpinned" } } } @@ -66874,13 +74978,13 @@ } } }, - "discussion-reopened": { + "enterprise-anonymous-access-disabled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was reopened.", - "operationId": "discussion/reopened", + "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", + "description": "Anonymous Git read access was disabled.", + "operationId": "enterprise/anonymous-access-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#enterprise" }, "parameters": [ { @@ -66902,7 +75006,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "discussions", + "example": "issues", "schema": { "type": "string" } @@ -66942,7 +75046,7 @@ { "name": "X-GitHub-Enterprise-Version", "in": "header", - "example": "3.9.0", + "example": "3.1.9", "schema": { "type": "string" } @@ -66961,7 +75065,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-reopened" + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-disabled" } } } @@ -66974,22 +75078,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "enterprise", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "discussion-transferred": { + "enterprise-anonymous-access-enabled": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was transferred to another repository.", - "operationId": "discussion/transferred", + "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", + "description": "Anonymous Git read access was enabled.", + "operationId": "enterprise/anonymous-access-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#enterprise" }, "parameters": [ { @@ -67070,7 +75172,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-transferred" + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-enabled" } } } @@ -67083,22 +75185,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "enterprise", "supported-webhook-types": [ - "repository", - "organization", - "app" + "business" ] } } }, - "discussion-unanswered": { + "fork": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A comment on the discussion was unmarked as the answer.", - "operationId": "discussion/unanswered", + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-server@3.15/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-server@3.15/rest/repos/forks)\" 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.", + "operationId": "fork", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { @@ -67179,7 +75278,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unanswered" + "$ref": "#/components/schemas/webhook-fork" } } } @@ -67192,8 +75291,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "fork", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -67201,13 +75301,13 @@ } } }, - "discussion-unlabeled": { + "github-app-authorization-revoked": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A label was removed from a discussion.", - "operationId": "discussion/unlabeled", + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.15/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { @@ -67288,7 +75388,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlabeled" + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" } } } @@ -67301,22 +75401,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "github_app_authorization", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "discussion-unlocked": { + "gollum": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unlocked.", - "operationId": "discussion/unlocked", + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-server@3.15/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { @@ -67397,7 +75494,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unlocked" + "$ref": "#/components/schemas/webhook-gollum" } } } @@ -67410,7 +75507,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "gollum", "supported-webhook-types": [ "repository", "organization", @@ -67419,13 +75516,13 @@ } } }, - "discussion-unpinned": { + "installation-created": { "post": { - "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.", - "description": "A discussion was unpinned.", - "operationId": "discussion/unpinned", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -67506,7 +75603,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-discussion-unpinned" + "$ref": "#/components/schemas/webhook-installation-created" } } } @@ -67519,22 +75616,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "discussion", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "enterprise-anonymous-access-disabled": { + "installation-deleted": { "post": { - "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", - "description": "Anonymous Git read access was disabled.", - "operationId": "enterprise/anonymous-access-disabled", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -67615,7 +75710,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-disabled" + "$ref": "#/components/schemas/webhook-installation-deleted" } } } @@ -67628,20 +75723,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "enterprise", + "subcategory": "installation", "supported-webhook-types": [ - "business" + "app" ] } } }, - "enterprise-anonymous-access-enabled": { + "installation-new-permissions-accepted": { "post": { - "summary": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access).\"", - "description": "Anonymous Git read access was enabled.", - "operationId": "enterprise/anonymous-access-enabled", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#enterprise" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -67722,7 +75817,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-enabled" + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" } } } @@ -67735,19 +75830,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "enterprise", + "subcategory": "installation", "supported-webhook-types": [ - "business" + "app" ] } } }, - "fork": { + "installation-repositories-added": { "post": { - "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-server@3.9/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-server@3.9/rest/repos/forks)\" 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.", - "operationId": "fork", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#fork" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -67828,7 +75924,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-fork" + "$ref": "#/components/schemas/webhook-installation-repositories-added" } } } @@ -67841,23 +75937,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "fork", + "subcategory": "installation_repositories", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "github-app-authorization-revoked": { + "installation-repositories-removed": { "post": { - "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", - "description": "Someone revoked their authorization of a GitHub App.", - "operationId": "github-app-authorization/revoked", + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#github_app_authorization" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { @@ -67938,7 +76031,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + "$ref": "#/components/schemas/webhook-installation-repositories-removed" } } } @@ -67951,19 +76044,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "github_app_authorization", + "subcategory": "installation_repositories", "supported-webhook-types": [ "app" ] } } }, - "gollum": { + "installation-suspend": { "post": { - "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/enterprise-server@3.9/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "gollum", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#gollum" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -68044,7 +76138,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-gollum" + "$ref": "#/components/schemas/webhook-installation-suspend" } } } @@ -68057,22 +76151,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "gollum", + "subcategory": "installation", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "installation-created": { + "installation-target-renamed": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "Someone installed a GitHub App on a user or organization account.", - "operationId": "installation/created", + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { @@ -68153,7 +76245,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-created" + "$ref": "#/components/schemas/webhook-installation-target-renamed" } } } @@ -68166,20 +76258,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "installation_target", "supported-webhook-types": [ "app" ] } } }, - "installation-deleted": { + "installation-unsuspend": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "Someone uninstalled a GitHub App from their user or organization account.", - "operationId": "installation/deleted", + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.15/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.15/rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { @@ -68260,7 +76352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-deleted" + "$ref": "#/components/schemas/webhook-installation-unsuspend" } } } @@ -68280,13 +76372,13 @@ } } }, - "installation-new-permissions-accepted": { + "issue-comment-created": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "Someone granted new permissions to a GitHub App.", - "operationId": "installation/new-permissions-accepted", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.15/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.15/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -68367,7 +76459,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + "$ref": "#/components/schemas/webhook-issue-comment-created" } } } @@ -68380,20 +76472,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-added": { + "issue-comment-deleted": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "A GitHub App installation was granted access to one or more repositories.", - "operationId": "installation-repositories/added", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.15/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.15/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -68474,7 +76568,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-added" + "$ref": "#/components/schemas/webhook-issue-comment-deleted" } } } @@ -68487,20 +76581,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-repositories-removed": { + "issue-comment-edited": { "post": { - "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "Access to one or more repositories was revoked for a GitHub App installation.", - "operationId": "installation-repositories/removed", + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.15/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.15/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_repositories" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { @@ -68581,7 +76677,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-repositories-removed" + "$ref": "#/components/schemas/webhook-issue-comment-edited" } } } @@ -68594,20 +76690,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_repositories", + "subcategory": "issue_comment", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-suspend": { + "issues-assigned": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "Someone blocked access by a GitHub App to their user or organization account.", - "operationId": "installation/suspend", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -68688,7 +76786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-suspend" + "$ref": "#/components/schemas/webhook-issues-assigned" } } } @@ -68701,20 +76799,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issues", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-target-renamed": { + "issues-closed": { "post": { - "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", - "operationId": "installation-target/renamed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was closed.", + "operationId": "issues/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_target" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -68795,7 +76895,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-target-renamed" + "$ref": "#/components/schemas/webhook-issues-closed" } } } @@ -68808,20 +76908,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation_target", + "subcategory": "issues", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "installation-unsuspend": { + "issues-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)\" in the REST API documentation.", - "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", - "operationId": "installation/unsuspend", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -68902,7 +77004,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-installation-unsuspend" + "$ref": "#/components/schemas/webhook-issues-deleted" } } } @@ -68915,20 +77017,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "installation", + "subcategory": "issues", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "issue-comment-created": { + "issues-demilestoned": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was created.", - "operationId": "issue-comment/created", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69009,7 +77113,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-created" + "$ref": "#/components/schemas/webhook-issues-demilestoned" } } } @@ -69022,7 +77126,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -69031,13 +77135,13 @@ } } }, - "issue-comment-deleted": { + "issues-edited": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was deleted.", - "operationId": "issue-comment/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69118,7 +77222,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-deleted" + "$ref": "#/components/schemas/webhook-issues-edited" } } } @@ -69131,7 +77235,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -69140,13 +77244,13 @@ } } }, - "issue-comment-edited": { + "issues-labeled": { "post": { - "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A comment on an issue or pull request was edited.", - "operationId": "issue-comment/edited", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69227,7 +77331,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issue-comment-edited" + "$ref": "#/components/schemas/webhook-issues-labeled" } } } @@ -69240,7 +77344,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issue_comment", + "subcategory": "issues", "supported-webhook-types": [ "repository", "organization", @@ -69249,13 +77353,13 @@ } } }, - "issues-assigned": { + "issues-locked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was assigned to a user.", - "operationId": "issues/assigned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69336,7 +77440,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issues-locked" } } } @@ -69358,13 +77462,13 @@ } } }, - "issues-closed": { + "issues-milestoned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was closed.", - "operationId": "issues/closed", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69445,7 +77549,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issues-milestoned" } } } @@ -69467,13 +77571,13 @@ } } }, - "issues-deleted": { + "issues-opened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was deleted.", - "operationId": "issues/deleted", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69554,7 +77658,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issues-opened" } } } @@ -69576,13 +77680,13 @@ } } }, - "issues-demilestoned": { + "issues-pinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was removed from a milestone.", - "operationId": "issues/demilestoned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69663,7 +77767,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issues-pinned" } } } @@ -69685,13 +77789,13 @@ } } }, - "issues-edited": { + "issues-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "The title or body on an issue was edited.", - "operationId": "issues/edited", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69772,7 +77876,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issues-reopened" } } } @@ -69794,13 +77898,13 @@ } } }, - "issues-labeled": { + "issues-transferred": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was added to an issue.", - "operationId": "issues/labeled", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69881,7 +77985,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issues-transferred" } } } @@ -69903,13 +78007,13 @@ } } }, - "issues-locked": { + "issues-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/locked", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -69990,7 +78094,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-unassigned" } } } @@ -70012,13 +78116,13 @@ } } }, - "issues-milestoned": { + "issues-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was added to a milestone.", - "operationId": "issues/milestoned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -70099,7 +78203,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-unlabeled" } } } @@ -70121,13 +78225,13 @@ } } }, - "issues-opened": { + "issues-unlocked": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", - "operationId": "issues/opened", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -70208,7 +78312,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-unlocked" } } } @@ -70230,13 +78334,13 @@ } } }, - "issues-pinned": { + "issues-unpinned": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/pinned", + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.15/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.15/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { @@ -70317,7 +78421,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-unpinned" } } } @@ -70339,13 +78443,231 @@ } } }, - "issues-reopened": { + "label-created": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A closed issue was reopened.", - "operationId": "issues/reopened", + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.15/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#label" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-label-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "label", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.15/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#label" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-label-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "label", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-edited": { + "post": { + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.15/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { @@ -70426,7 +78748,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-label-edited" } } } @@ -70439,7 +78761,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "label", "supported-webhook-types": [ "repository", "organization", @@ -70448,13 +78770,13 @@ } } }, - "issues-transferred": { + "member-added": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", - "operationId": "issues/transferred", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -70535,7 +78857,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-member-added" } } } @@ -70548,8 +78870,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -70557,13 +78880,13 @@ } } }, - "issues-unassigned": { + "member-edited": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A user was unassigned from an issue.", - "operationId": "issues/unassigned", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -70644,7 +78967,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-member-edited" } } } @@ -70657,8 +78980,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -70666,13 +78990,13 @@ } } }, - "issues-unlabeled": { + "member-removed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "A label was removed from an issue.", - "operationId": "issues/unlabeled", + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.15/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { @@ -70753,7 +79077,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-member-removed" } } } @@ -70766,8 +79090,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "member", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -70775,13 +79100,13 @@ } } }, - "issues-unlocked": { + "membership-added": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "issues/unlocked", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.15/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.15/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -70862,7 +79187,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-membership-added" } } } @@ -70875,22 +79200,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "membership", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "issues-unpinned": { + "membership-removed": { "post": { - "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", - "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", - "operationId": "issues/unpinned", + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.15/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.15/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { @@ -70971,7 +79296,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-membership-removed" } } } @@ -70984,22 +79309,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "issues", + "subcategory": "membership", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "label-created": { + "meta-deleted": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was created.", - "operationId": "label/created", + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { @@ -71080,7 +79405,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-meta-deleted" } } } @@ -71093,8 +79418,10 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "meta", "supported-webhook-types": [ + "marketplace", + "business", "repository", "organization", "app" @@ -71102,13 +79429,13 @@ } } }, - "label-deleted": { + "milestone-closed": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label was deleted.", - "operationId": "label/deleted", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.15/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -71189,7 +79516,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-milestone-closed" } } } @@ -71202,7 +79529,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -71211,13 +79538,13 @@ } } }, - "label-edited": { + "milestone-created": { "post": { - "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A label's name, description, or color was changed.", - "operationId": "label/edited", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.15/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -71298,7 +79625,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-milestone-created" } } } @@ -71311,7 +79638,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "label", + "subcategory": "milestone", "supported-webhook-types": [ "repository", "organization", @@ -71320,13 +79647,13 @@ } } }, - "member-added": { + "milestone-deleted": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A GitHub user accepted an invitation to a repository.", - "operationId": "member/added", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.15/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -71407,7 +79734,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -71420,9 +79747,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "milestone", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -71430,13 +79756,13 @@ } } }, - "member-edited": { + "milestone-edited": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "Permissions were changed for a collaborator on a repository.", - "operationId": "member/edited", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.15/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -71517,7 +79843,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -71530,9 +79856,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "milestone", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -71540,13 +79865,13 @@ } } }, - "member-removed": { + "milestone-opened": { "post": { - "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A collaborator was removed from a repository.", - "operationId": "member/removed", + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.15/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.15/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { @@ -71627,7 +79952,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -71640,9 +79965,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "member", + "subcategory": "milestone", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -71650,13 +79974,13 @@ } } }, - "membership-added": { + "organization-deleted": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.9/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was added to a team.", - "operationId": "membership/added", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.15/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization was deleted.", + "operationId": "organization/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -71737,7 +80061,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -71750,7 +80074,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "organization", "supported-webhook-types": [ "organization", "business", @@ -71759,13 +80083,13 @@ } } }, - "membership-removed": { + "organization-member-added": { "post": { - "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-server@3.9/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization member was removed from a team.", - "operationId": "membership/removed", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.15/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#membership" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -71846,7 +80170,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -71859,7 +80183,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "membership", + "subcategory": "organization", "supported-webhook-types": [ "organization", "business", @@ -71868,124 +80192,13 @@ } } }, - "meta-deleted": { - "post": { - "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", - "description": "The webhook was deleted.", - "operationId": "meta/deleted", - "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#meta" - }, - "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" - } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-meta-deleted" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "meta", - "supported-webhook-types": [ - "marketplace", - "business", - "repository", - "organization", - "app" - ] - } - } - }, - "milestone-closed": { + "organization-member-invited": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was closed.", - "operationId": "milestone/closed", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.15/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -72066,7 +80279,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -72079,22 +80292,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "milestone-created": { + "organization-member-removed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.15/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -72175,7 +80388,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -72188,22 +80401,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "milestone-deleted": { + "organization-renamed": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.15/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -72284,7 +80497,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -72297,22 +80510,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "organization", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "milestone-edited": { + "package-published": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.15/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A package was published to a registry.", + "operationId": "package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -72393,7 +80606,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -72406,7 +80619,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -72415,13 +80628,13 @@ } } }, - "milestone-opened": { + "package-updated": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.15/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -72502,7 +80715,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-package-updated" } } } @@ -72515,7 +80728,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "package", "supported-webhook-types": [ "repository", "organization", @@ -72524,13 +80737,12 @@ } } }, - "organization-deleted": { + "page-build": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "An organization was deleted.", - "operationId": "organization/deleted", + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.15/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-server@3.15/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -72611,7 +80823,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -72624,22 +80836,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "page_build", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "organization-member-added": { + "personal-access-token-request-approved": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member accepted an invitation to join an organization.", - "operationId": "organization/member-added", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.15/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -72651,9 +80863,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -72661,31 +80873,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -72697,22 +80909,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -72720,7 +80916,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } @@ -72733,22 +80929,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "organization-member-invited": { + "personal-access-token-request-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was invited to join the organization.", - "operationId": "organization/member-invited", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.15/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -72760,9 +80954,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -72770,31 +80964,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -72806,22 +81000,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -72829,7 +81007,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -72842,22 +81020,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "organization-member-removed": { + "personal-access-token-request-created": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A member was removed from the organization.", - "operationId": "organization/member-removed", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.15/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -72869,9 +81045,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -72879,31 +81055,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -72915,22 +81091,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -72938,7 +81098,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -72951,22 +81111,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "organization-renamed": { + "personal-access-token-request-denied": { "post": { - "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name of an organization was changed.", - "operationId": "organization/renamed", + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-server@3.15/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.\n\n> [!NOTE]\n> Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -72978,9 +81136,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -72988,31 +81146,31 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Id", + "name": "X-Github-Hook-Id", "in": "header", - "example": 123123, + "example": 12312312, "schema": { "type": "string" } }, { - "name": "X-Github-Hook-Installation-Target-Type", + "name": "X-Github-Hook-Installation-Target-Id", "in": "header", - "example": "repository", + "example": 123123, "schema": { "type": "string" } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": "integration", "schema": { "type": "string" } @@ -73024,22 +81182,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -73047,7 +81189,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -73060,22 +81202,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "organization", - "business", "app" ] } } }, - "package-published": { + "ping": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A package was published to a registry.", - "operationId": "package/published", + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -73156,7 +81295,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } } } } @@ -73168,23 +81322,26 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "package", + "subcategory": "ping", "supported-webhook-types": [ "repository", "organization", - "app" + "app", + "business", + "marketplace" ] } } }, - "package-updated": { + "project-card-converted": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.", - "description": "A previously published package was updated.", - "operationId": "package/updated", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -73265,7 +81422,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -73278,7 +81435,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -73287,12 +81444,13 @@ } } }, - "page-build": { + "project-card-created": { "post": { - "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.9/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/enterprise-server@3.9/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", - "operationId": "page-build", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -73373,7 +81531,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-project-card-created" } } } @@ -73386,7 +81544,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", @@ -73395,139 +81553,13 @@ } } }, - "ping": { - "post": { - "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", - "operationId": "ping", - "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#ping" - }, - "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" - } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-ping" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-ping-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/ping-form-encoded" - } - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "webhooks", - "subcategory": "ping", - "supported-webhook-types": [ - "repository", - "organization", - "app", - "business", - "marketplace" - ] - } - } - }, - "project-card-converted": { + "project-card-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note in a project (classic) was converted to an issue.", - "operationId": "project-card/converted", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -73608,7 +81640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -73630,13 +81662,13 @@ } } }, - "project-card-created": { + "project-card-edited": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card was added to a project (classic).", - "operationId": "project-card/created", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -73717,7 +81749,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -73739,13 +81771,13 @@ } } }, - "project-card-deleted": { + "project-card-moved": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was deleted.", - "operationId": "project-card/deleted", + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -73826,7 +81858,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -73848,13 +81880,13 @@ } } }, - "project-card-edited": { + "project-closed": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A note on a project (classic) was edited.", - "operationId": "project-card/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -73935,7 +81967,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -73948,7 +81980,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -73957,13 +81989,13 @@ } } }, - "project-card-moved": { + "project-column-created": { "post": { - "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A card on a project (classic) was moved to another column or to another position in its column.", - "operationId": "project-card/moved", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -74044,7 +82076,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -74057,7 +82089,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -74066,13 +82098,13 @@ } } }, - "project-closed": { + "project-column-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/closed", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -74153,7 +82185,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -74166,7 +82198,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -74175,13 +82207,13 @@ } } }, - "project-column-created": { + "project-column-edited": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was added to a project (classic).", - "operationId": "project-column/created", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -74262,7 +82294,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -74284,13 +82316,13 @@ } } }, - "project-column-deleted": { + "project-column-moved": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was deleted from a project (classic).", - "operationId": "project-column/deleted", + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -74371,7 +82403,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -74393,13 +82425,13 @@ } } }, - "project-column-edited": { + "project-created": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name of a column on a project (classic) was changed.", - "operationId": "project-column/edited", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was created.", + "operationId": "project/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -74480,7 +82512,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -74493,7 +82525,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -74502,13 +82534,13 @@ } } }, - "project-column-moved": { + "project-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A column was moved to a new position on a project (classic).", - "operationId": "project-column/moved", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -74589,7 +82621,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -74602,7 +82634,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -74611,13 +82643,13 @@ } } }, - "project-created": { + "project-edited": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was created.", - "operationId": "project/created", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -74698,7 +82730,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -74720,13 +82752,13 @@ } } }, - "project-deleted": { + "project-reopened": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was deleted.", - "operationId": "project/deleted", + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.15/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.15/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -74807,7 +82839,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -74829,13 +82861,13 @@ } } }, - "project-edited": { + "projects-v2-closed": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "The name or description of a project (classic) was changed.", - "operationId": "project/edited", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -74857,7 +82889,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -74916,7 +82948,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -74928,23 +82960,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "project-reopened": { + "projects-v2-created": { "post": { - "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", - "description": "A project (classic) was closed.", - "operationId": "project/reopened", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -74966,7 +82997,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -75025,7 +83056,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -75037,23 +83068,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "projects-v2-closed": { + "projects-v2-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was closed.", - "operationId": "projects-v2/closed", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -75134,7 +83164,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -75155,13 +83185,13 @@ } } }, - "projects-v2-created": { + "projects-v2-edited": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was created.", - "operationId": "projects-v2/created", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -75242,7 +83272,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -75263,13 +83293,13 @@ } } }, - "projects-v2-deleted": { + "projects-v2-item-archived": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was deleted.", - "operationId": "projects-v2/deleted", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -75291,7 +83321,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -75350,7 +83380,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -75364,20 +83394,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-edited": { + "projects-v2-item-converted": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The title, description, or README of a project in the organization was changed.", - "operationId": "projects-v2/edited", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -75399,7 +83429,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -75458,7 +83488,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -75472,20 +83502,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-archived": { + "projects-v2-item-created": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -75566,7 +83596,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -75587,13 +83617,13 @@ } } }, - "projects-v2-item-converted": { + "projects-v2-item-deleted": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A draft issue in an organization project was converted to an issue.", - "operationId": "projects-v2-item/converted", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -75674,7 +83704,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -75695,13 +83725,13 @@ } } }, - "projects-v2-item-created": { + "projects-v2-item-edited": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was added to a project in the organization.", - "operationId": "projects-v2-item/created", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -75782,7 +83812,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -75803,13 +83833,13 @@ } } }, - "projects-v2-item-deleted": { + "projects-v2-item-reordered": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An item was deleted from a project in the organization.", - "operationId": "projects-v2-item/deleted", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -75890,7 +83920,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -75911,13 +83941,13 @@ } } }, - "projects-v2-item-edited": { + "projects-v2-item-restored": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", - "operationId": "projects-v2-item/edited", + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -75998,7 +84028,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -76019,13 +84049,13 @@ } } }, - "projects-v2-item-reordered": { + "projects-v2-reopened": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", - "operationId": "projects-v2-item/reordered", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.15/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -76047,7 +84077,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -76106,7 +84136,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -76120,20 +84150,19 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-restored": { + "public": { "post": { - "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -76155,7 +84184,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "issues", "schema": { "type": "string" } @@ -76214,7 +84243,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-public" } } } @@ -76226,22 +84255,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "public", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-reopened": { + "pull-request-assigned": { "post": { - "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", - "description": "A project in the organization was reopened.", - "operationId": "projects-v2/reopened", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -76263,7 +84293,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "issues", "schema": { "type": "string" } @@ -76322,7 +84352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -76334,21 +84364,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "pull_request", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "public": { + "pull-request-auto-merge-disabled": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "operationId": "public", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -76429,7 +84461,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -76442,7 +84474,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "public", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -76451,13 +84483,13 @@ } } }, - "pull-request-assigned": { + "pull-request-auto-merge-enabled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was assigned to a user.", - "operationId": "pull-request/assigned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -76538,7 +84570,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -76560,13 +84592,122 @@ } } }, - "pull-request-auto-merge-disabled": { + "pull-request-closed": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", + "externalDocs": { + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" + }, + "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" + } + }, + { + "name": "X-GitHub-Enterprise-Version", + "in": "header", + "example": "3.1.9", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Enterprise-Host", + "in": "header", + "example": "ghes.github.com", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-converted-to-draft": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -76647,7 +84788,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -76669,13 +84810,13 @@ } } }, - "pull-request-auto-merge-enabled": { + "pull-request-demilestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -76756,7 +84897,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -76778,13 +84919,13 @@ } } }, - "pull-request-closed": { + "pull-request-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", - "operationId": "pull-request/closed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -76865,7 +85006,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -76887,13 +85028,13 @@ } } }, - "pull-request-converted-to-draft": { + "pull-request-labeled": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/converted-to-draft", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -76974,7 +85115,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -76996,13 +85137,13 @@ } } }, - "pull-request-demilestoned": { + "pull-request-locked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was removed from a milestone.", - "operationId": "pull-request/demilestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -77083,7 +85224,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -77105,13 +85246,13 @@ } } }, - "pull-request-edited": { + "pull-request-milestoned": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", - "operationId": "pull-request/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -77192,7 +85333,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -77214,13 +85355,13 @@ } } }, - "pull-request-labeled": { + "pull-request-opened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was added to a pull request.", - "operationId": "pull-request/labeled", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -77301,7 +85442,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -77323,13 +85464,13 @@ } } }, - "pull-request-locked": { + "pull-request-ready-for-review": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -77410,7 +85551,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -77432,13 +85573,13 @@ } } }, - "pull-request-milestoned": { + "pull-request-reopened": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was added to a milestone.", - "operationId": "pull-request/milestoned", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -77519,7 +85660,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -77541,13 +85682,13 @@ } } }, - "pull-request-opened": { + "pull-request-review-comment-created": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request was created", - "operationId": "pull-request/opened", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -77628,7 +85769,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -77641,7 +85782,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -77650,13 +85791,13 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-review-comment-deleted": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", - "operationId": "pull-request/ready-for-review", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -77737,7 +85878,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -77750,7 +85891,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -77759,13 +85900,13 @@ } } }, - "pull-request-reopened": { + "pull-request-review-comment-edited": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously closed pull request was reopened.", - "operationId": "pull-request/reopened", + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -77846,7 +85987,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -77859,7 +86000,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -77868,13 +86009,13 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-review-dismissed": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was created.", - "operationId": "pull-request-review-comment/created", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -77955,7 +86096,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -77968,7 +86109,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -77977,13 +86118,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-review-edited": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment on a pull request diff was deleted.", - "operationId": "pull-request-review-comment/deleted", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -78064,7 +86205,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -78077,7 +86218,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -78086,13 +86227,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-review-request-removed": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The content of a comment on a pull request diff was changed.", - "operationId": "pull-request-review-comment/edited", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -78173,7 +86314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -78186,7 +86327,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -78195,13 +86336,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-review-requested": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was dismissed.", - "operationId": "pull-request-review/dismissed", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -78282,7 +86423,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" } } } @@ -78295,7 +86436,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -78304,13 +86445,13 @@ } } }, - "pull-request-review-edited": { + "pull-request-review-submitted": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "The body comment on a pull request review was edited.", - "operationId": "pull-request-review/edited", + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -78391,7 +86532,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -78413,13 +86554,13 @@ } } }, - "pull-request-review-request-removed": { + "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A request for review by a person or team was removed from a pull request.", - "operationId": "pull-request/review-request-removed", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -78500,7 +86641,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -78513,7 +86654,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -78522,13 +86663,13 @@ } } }, - "pull-request-review-requested": { + "pull-request-review-thread-unresolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", - "operationId": "pull-request/review-requested", + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -78609,7 +86750,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -78622,7 +86763,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -78631,13 +86772,13 @@ } } }, - "pull-request-review-submitted": { + "pull-request-synchronize": { "post": { - "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A review on a pull request was submitted.", - "operationId": "pull-request-review/submitted", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -78718,7 +86859,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -78731,7 +86872,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -78740,13 +86881,13 @@ } } }, - "pull-request-review-thread-resolved": { + "pull-request-unassigned": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A comment thread on a pull request was marked as resolved.", - "operationId": "pull-request-review-thread/resolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -78827,7 +86968,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -78840,7 +86981,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -78849,13 +86990,13 @@ } } }, - "pull-request-review-thread-unresolved": { + "pull-request-unlabeled": { "post": { - "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A previously resolved comment thread on a pull request was marked as unresolved.", - "operationId": "pull-request-review-thread/unresolved", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -78936,7 +87077,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -78949,7 +87090,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -78958,13 +87099,13 @@ } } }, - "pull-request-synchronize": { + "pull-request-unlocked": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", - "operationId": "pull-request/synchronize", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -79045,7 +87186,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -79067,13 +87208,12 @@ } } }, - "pull-request-unassigned": { + "push": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A user was unassigned from a pull request.", - "operationId": "pull-request/unassigned", + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -79154,7 +87294,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-push" } } } @@ -79167,7 +87307,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -79176,13 +87316,13 @@ } } }, - "pull-request-unlabeled": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "A label was removed from a pull request.", - "operationId": "pull-request/unlabeled", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.15/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -79263,7 +87403,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -79276,7 +87416,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -79285,13 +87425,13 @@ } } }, - "pull-request-unlocked": { + "registry-package-updated": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", - "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.15/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -79372,7 +87512,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -79385,7 +87525,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -79394,12 +87534,13 @@ } } }, - "push": { + "release-created": { "post": { - "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.", - "operationId": "push", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.15/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-server@3.15/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.15/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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -79480,7 +87621,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -79493,7 +87634,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -79502,13 +87643,13 @@ } } }, - "registry-package-published": { + "release-deleted": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package was published to a registry.", - "operationId": "registry-package/published", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.15/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-server@3.15/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.15/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 release was deleted.", + "operationId": "release/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -79589,7 +87730,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -79602,7 +87743,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -79611,13 +87752,13 @@ } } }, - "registry-package-updated": { + "release-edited": { "post": { - "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n**Note**: GitHub recommends that you use the newer `package` event instead.", - "description": "A package that was previously published to a registry was updated.", - "operationId": "registry-package/updated", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.15/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-server@3.15/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.15/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-server@3.15/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -79698,7 +87839,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -79711,7 +87852,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -79720,13 +87861,13 @@ } } }, - "release-created": { + "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-server@3.9/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-server@3.9/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.9/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 draft was saved, or a release or pre-release was published without previously being saved as a draft.", - "operationId": "release/created", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.15/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-server@3.15/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -79807,7 +87948,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -79829,13 +87970,13 @@ } } }, - "release-deleted": { + "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-server@3.9/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-server@3.9/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.9/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 release was deleted.", - "operationId": "release/deleted", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.15/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-server@3.15/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -79916,7 +88057,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -79938,13 +88079,13 @@ } } }, - "release-edited": { + "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-server@3.9/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-server@3.9/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.9/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": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.15/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-server@3.15/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -80025,7 +88166,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -80047,13 +88188,13 @@ } } }, - "release-prereleased": { + "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-server@3.9/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-server@3.9/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.9/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", + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.15/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-server@3.15/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -80134,7 +88275,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -80156,13 +88297,13 @@ } } }, - "release-published": { + "repository-anonymous-access-disabled": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.9/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-server@3.9/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.9/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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": "Someone disabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", + "operationId": "repository/anonymous-access-disabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -80243,7 +88384,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-repository-anonymous-access-disabled" } } } @@ -80256,22 +88397,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository", "supported-webhook-types": [ - "repository", + "app", + "business", "organization", - "app" + "repository" ] } } }, - "release-released": { + "repository-anonymous-access-enabled": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.9/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-server@3.9/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.9/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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": "Someone enabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", + "operationId": "repository/anonymous-access-enabled", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -80352,7 +88494,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-repository-anonymous-access-enabled" } } } @@ -80365,22 +88507,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository", "supported-webhook-types": [ - "repository", + "app", + "business", "organization", - "app" + "repository" ] } } }, - "release-unpublished": { + "repository-archived": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-server@3.9/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-server@3.9/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-server@3.9/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 repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -80461,7 +88604,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -80474,8 +88617,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -80483,13 +88627,13 @@ } } }, - "repository-anonymous-access-disabled": { + "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-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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": "Someone disabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", - "operationId": "repository/anonymous-access-disabled", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -80570,7 +88714,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-anonymous-access-disabled" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -80585,21 +88729,21 @@ "category": "webhooks", "subcategory": "repository", "supported-webhook-types": [ - "app", "business", + "repository", "organization", - "repository" + "app" ] } } }, - "repository-anonymous-access-enabled": { + "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-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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": "Someone enabled anonymous Git read access to the repository. For more information, see \"[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository).\"", - "operationId": "repository/anonymous-access-enabled", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -80680,7 +88824,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-anonymous-access-enabled" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -80695,21 +88839,20 @@ "category": "webhooks", "subcategory": "repository", "supported-webhook-types": [ - "app", "business", + "repository", "organization", - "repository" + "app" ] } } }, - "repository-archived": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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", + "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-server@3.15/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -80790,7 +88933,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -80803,23 +88946,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-created": { + "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-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -80900,7 +89040,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -80923,13 +89063,13 @@ } } }, - "repository-deleted": { + "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-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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 there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -81010,7 +89150,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -81033,12 +89173,13 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-publicized": { "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-server@3.9/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "operationId": "repository-dispatch/sample.collected", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -81119,7 +89260,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -81132,20 +89273,23 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository", "supported-webhook-types": [ + "business", + "repository", + "organization", "app" ] } } }, - "repository-edited": { + "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-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -81226,7 +89370,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -81249,13 +89393,13 @@ } } }, - "repository-privatized": { + "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-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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", + "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-server@3.15/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-server@3.15/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.15/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -81313,22 +89457,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -81336,7 +89464,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -81349,9 +89477,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -81359,13 +89486,13 @@ } } }, - "repository-publicized": { + "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-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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-server@3.15/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-server@3.15/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.15/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -81423,22 +89550,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -81446,7 +89557,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -81459,9 +89570,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -81469,13 +89579,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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-server@3.15/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-server@3.15/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-server@3.15/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -81533,22 +89643,6 @@ "schema": { "type": "string" } - }, - { - "name": "X-GitHub-Enterprise-Version", - "in": "header", - "example": "3.1.9", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Enterprise-Host", - "in": "header", - "example": "ghes.github.com", - "schema": { - "type": "string" - } } ], "requestBody": { @@ -81556,7 +89650,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -81569,9 +89663,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -81581,11 +89674,11 @@ }, "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -81691,11 +89784,11 @@ }, "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.9/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.", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -81801,11 +89894,11 @@ }, "repository-vulnerability-alert-create": { "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -81909,11 +90002,11 @@ }, "repository-vulnerability-alert-dismiss": { "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -82017,11 +90110,11 @@ }, "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -82125,11 +90218,11 @@ }, "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.", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", "description": "A repository vulnerability alert was marked as resolved.", "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -82233,11 +90326,11 @@ }, "secret-scanning-alert-created": { "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-server@3.9/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-server@3.9/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.", + "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-server@3.15/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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -82342,11 +90435,11 @@ }, "secret-scanning-alert-location-created": { "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-server@3.9/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-server@3.9/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.", + "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-server@3.15/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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -82467,11 +90560,11 @@ }, "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-server@3.9/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-server@3.9/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.", + "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-server@3.15/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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -82576,11 +90669,11 @@ }, "secret-scanning-alert-resolved": { "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-server@3.9/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-server@3.9/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.", + "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-server@3.15/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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -82683,13 +90776,13 @@ } } }, - "secret-scanning-alert-revoked": { + "secret-scanning-alert-validated": { "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-server@3.9/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-server@3.9/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 secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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 validated.", + "operationId": "secret-scanning-alert/validated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -82770,7 +90863,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } @@ -82794,11 +90887,11 @@ }, "security-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/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-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.15/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.15/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -82901,11 +90994,11 @@ }, "security-advisory-updated": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/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-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.15/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.15/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "The metadata or description of a security advisory was changed.", "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -83008,11 +91101,11 @@ }, "security-advisory-withdrawn": { "post": { - "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/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-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/enterprise-server@3.15/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.15/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", "description": "A previously published security advisory was withdrawn.", "operationId": "security-advisory/withdrawn", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -83115,10 +91208,10 @@ }, "security-and-analysis": { "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-server@3.9/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.", + "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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -83223,11 +91316,11 @@ }, "sponsorship-cancelled": { "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-server@3.9/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-server@3.9/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-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.15/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-server@3.15/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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -83330,11 +91423,11 @@ }, "sponsorship-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-server@3.9/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-server@3.9/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-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.15/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-server@3.15/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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -83437,11 +91530,11 @@ }, "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-server@3.9/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-server@3.9/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-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.15/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-server@3.15/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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -83544,11 +91637,11 @@ }, "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-server@3.9/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-server@3.9/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-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.15/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-server@3.15/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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -83651,11 +91744,11 @@ }, "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-server@3.9/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-server@3.9/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-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.15/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-server@3.15/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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -83758,11 +91851,11 @@ }, "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-server@3.9/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-server@3.9/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-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "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-server@3.15/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-server@3.15/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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -83865,11 +91958,11 @@ }, "star-created": { "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-server@3.9/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-server@3.9/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.9/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.", + "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-server@3.15/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-server@3.15/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -83974,11 +92067,11 @@ }, "star-deleted": { "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-server@3.9/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-server@3.9/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.9/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.", + "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-server@3.15/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-server@3.15/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -84083,10 +92176,10 @@ }, "status": { "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-server@3.9/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-server@3.9/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-server@3.9/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.", + "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-server@3.15/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-server@3.15/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -84191,10 +92284,10 @@ }, "team-add": { "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-server@3.9/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.", + "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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -84299,11 +92392,11 @@ }, "team-added-to-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-server@3.9/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.", + "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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -84408,11 +92501,11 @@ }, "team-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-server@3.9/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.", + "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-server@3.15/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-server@3.9/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -84517,11 +92610,11 @@ }, "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-server@3.9/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.", + "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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -84626,11 +92719,11 @@ }, "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-server@3.9/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.", + "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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -84735,11 +92828,11 @@ }, "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-server@3.9/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.", + "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-server@3.15/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", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -84848,7 +92941,7 @@ "description": "A user account was added to the enterprise.", "operationId": "user/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#user" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#user" }, "parameters": [ { @@ -84955,7 +93048,7 @@ "description": "A user account was removed from the enterprise.", "operationId": "user/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#user" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#user" }, "parameters": [ { @@ -85058,11 +93151,11 @@ }, "watch-started": { "post": { - "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-server@3.9/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-server@3.9/rest/activity/watching)\" 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.", + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/enterprise-server@3.15/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/enterprise-server@3.15/rest/activity/watching)\" 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 started watching the repository.", "operationId": "watch/started", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#watch" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { @@ -85167,10 +93260,10 @@ }, "workflow-dispatch": { "post": { - "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-server@3.9/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/enterprise-server@3.15/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "workflow-dispatch", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_dispatch" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { @@ -85273,11 +93366,11 @@ }, "workflow-job-completed": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", "operationId": "workflow-job/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -85383,11 +93476,11 @@ }, "workflow-job-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run started processing on a runner.", "operationId": "workflow-job/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -85493,11 +93586,11 @@ }, "workflow-job-queued": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created.", "operationId": "workflow-job/queued", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -85603,11 +93696,11 @@ }, "workflow-job-waiting": { "post": { - "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A job in a workflow run was created and is waiting for approvals.", "operationId": "workflow-job/waiting", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { @@ -85713,11 +93806,11 @@ }, "workflow-run-completed": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.15/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", "operationId": "workflow-run/completed", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -85823,11 +93916,11 @@ }, "workflow-run-in-progress": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.15/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run started processing on a runner.", "operationId": "workflow-run/in-progress", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -85933,11 +94026,11 @@ }, "workflow-run-requested": { "post": { - "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/enterprise-server@3.15/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", "description": "A workflow run was triggered.", "operationId": "workflow-run/requested", "externalDocs": { - "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run" + "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { @@ -86320,7 +94413,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "key": { "type": "string" @@ -86331,7 +94425,8 @@ }, "repository_id": { "nullable": true, - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -86403,6 +94498,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -86431,6 +94529,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -86625,6 +94724,10 @@ }, "business_plus": { "type": "boolean" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -86744,7 +94847,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -86843,7 +94947,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "type": "string" @@ -86911,6 +95016,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -86988,6 +95094,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -87121,6 +95231,14 @@ "write" ] }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, "repository_hooks": { "type": "string", "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", @@ -87217,9 +95335,26 @@ "write" ] }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for custom property management.", + "enum": [ + "read", + "write", + "admin" + ] + }, "organization_copilot_seat_management": { "type": "string", - "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", "enum": [ "write" ] @@ -87272,7 +95407,7 @@ }, "organization_projects": { "type": "string", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", "enum": [ "read", "write", @@ -87373,6 +95508,14 @@ "read", "write" ] + }, + "enterprise_administration": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] } }, "example": { @@ -87401,6 +95544,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -87478,6 +95622,10 @@ "starred_at": { "type": "string", "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -87559,7 +95707,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string", @@ -87653,6 +95802,438 @@ "expires_at" ] }, + "security-advisory-ecosystems": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, + "cvss-severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "security-advisory-credit-types": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "global-advisory": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true, + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": "string", + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": "string", + "format": "uri", + "description": "The URL of the advisory's source code.", + "nullable": true + }, + "identifiers": { + "type": "array", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": "array", + "nullable": true, + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "nvd_published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "vulnerabilities": { + "type": "array", + "description": "The products and respective version ranges affected by the advisory.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/vulnerability" + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "epss": { + "type": "object", + "nullable": true, + "properties": { + "percentage": { + "type": "number" + }, + "percentile": { + "type": "number" + } + } + }, + "credits": { + "type": "array", + "description": "In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available.", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false + }, + "basic-error": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "validation-error-simple": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, "integration": { "title": "GitHub app", "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", @@ -87673,6 +96254,10 @@ "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, "owner": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -87750,10 +96335,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -87782,48 +96363,6 @@ "events" ] }, - "basic-error": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "validation-error-simple": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, "webhook-config-url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -87837,7 +96376,7 @@ }, "webhook-config-secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers).", "example": "\"********\"" }, "webhook-config-insecure-ssl": { @@ -87934,6 +96473,13 @@ "type": "integer", "example": 123, "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true } }, "required": [ @@ -88108,6 +96654,13 @@ "example": 123, "nullable": true }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + }, "url": { "description": "The URL target of the delivery.", "type": "string", @@ -88460,7 +97013,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -88861,7 +97415,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -89066,6 +97620,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1 }, "url": { @@ -89162,7 +97717,7 @@ }, "announcement-message": { "type": "string", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.9/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.15/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "example": "Very **important** announcement about _something_.", "nullable": true }, @@ -89477,6 +98032,57 @@ } } }, + "enterprise-security-products-overview": { + "title": "Enterprise Security Products Stats", + "type": "object", + "properties": { + "total_repos": { + "type": "integer" + }, + "nonarchived_repos": { + "type": "integer" + }, + "secret_scanning_enabled_repos": { + "type": "integer" + }, + "secret_scanning_push_protection_enabled_repos": { + "type": "integer" + }, + "code_scanning_enabled_repos": { + "type": "integer" + }, + "code_scanning_pr_reviews_enabled_repos": { + "type": "integer" + }, + "code_scanning_default_setup_enabled_repos": { + "type": "integer" + }, + "code_scanning_default_setup_eligible_repos": { + "type": "integer" + }, + "dependabot_alerts_enabled_repos": { + "type": "integer" + }, + "dependabot_security_updates_enabled_repos": { + "type": "integer" + }, + "dependabot_version_updates_enabled_repos": { + "type": "integer" + }, + "advanced_security_enabled_repos": { + "type": "integer" + }, + "active_committers": { + "type": "integer" + }, + "purchased_committers": { + "type": "integer" + }, + "maximum_committers": { + "type": "integer" + } + } + }, "actions-cache-usage-org-enterprise": { "type": "object", "properties": { @@ -90043,6 +98649,7 @@ "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", + "nullable": true, "enum": [ "open", "dismissed", @@ -90068,7 +98675,6 @@ "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", "nullable": true, "enum": [ - null, "false positive", "won't fix", "used in tests" @@ -90092,14 +98698,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "nullable": true, - "type": "array", - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "nullable": true, "type": "string", @@ -90125,6 +98723,14 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -90246,6 +98852,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269, "description": "A unique identifier of the repository." }, @@ -90613,6 +99220,11 @@ "example": false, "description": "Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to\nthis enterprise." }, + "advanced_security_enabled_for_new_user_namespace_repositories": { + "type": "boolean", + "example": false, + "description": "Whether GitHub Advanced Security is automatically enabled for new user namespace repositories." + }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, @@ -90633,6 +99245,11 @@ "nullable": true, "example": "https://github.com/test-org/test-repo/blob/main/README.md", "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise." } }, "required": [ @@ -90785,6 +99402,9 @@ ], "additionalProperties": false }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "description": "Details for the advisory pertaining to Common Weakness Enumeration.", @@ -91093,7 +99713,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -91120,6 +99740,15 @@ "type": "string", "description": "The comment that was optionally added when this alert was closed", "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } }, @@ -91132,11 +99761,16 @@ "last_pushed_date": { "type": "string", "example": "2021-11-03" + }, + "last_pushed_email": { + "type": "string", + "example": "monalisa@github.com" } }, "required": [ "user_login", - "last_pushed_date" + "last_pushed_date", + "last_pushed_email" ] }, "advanced-security-active-committers-repository": { @@ -91174,6 +99808,16 @@ "type": "integer", "example": 2 }, + "maximum_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security" + }, + "purchased_advanced_security_committers": { + "type": "integer", + "example": 4, + "description": "The total number of GitHub Advanced Security licences purchased" + }, "repositories": { "type": "array", "items": { @@ -91347,6 +99991,10 @@ "type": "string", "example": "MDExOkludGVncmF0aW9uMQ==" }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, "owner": { "$ref": "#/components/schemas/nullable-simple-user" }, @@ -91424,10 +100072,6 @@ "example": 5, "type": "integer" }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, "client_secret": { "type": "string", "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" @@ -91521,6 +100165,26 @@ "rocket" ] }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", @@ -91737,6 +100401,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -92108,6 +100775,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -92180,7 +100852,11 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" }, "node_id": { "type": "string" @@ -92260,6 +100936,11 @@ "format": "email", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -92315,11 +100996,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "private_gists": { "type": "integer", "example": 1 @@ -92620,6 +101296,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -92909,6 +101590,326 @@ "featured" ] }, + "ghes-get-ssh": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "format": "ssh-key", + "description": "The full public key" + }, + "fingerprint": { + "type": "string", + "format": "ssh-key fingerprint", + "description": "The fingerprint of the key" + } + } + } + }, + "ghes-set-ssh-request": { + "title": "Set SSH key", + "type": "object", + "properties": { + "key": { + "description": "The public SSH key to add to the `authorized_keys` file.", + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "ghes-set-ssh-response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname", + "description": "Hostname of the node where the SSH key was added." + }, + "uuid": { + "type": "string", + "format": "uuid", + "description": "UUID of the SSH key that was added." + }, + "message": { + "type": "string", + "description": "Message indicating the result of the SSH key addition." + }, + "error": { + "type": "string", + "description": "Error message indicating the reason for the SSH key addition failure. This field is only present if the SSH key addition failed." + }, + "modified": { + "type": "boolean", + "description": "Whether the SSH key was already present on the `authorized_keys` file." + } + } + } + }, + "ghes-delete-ssh-request": { + "title": "Set SSH key", + "type": "object", + "properties": { + "key": { + "description": "The public SSH key to remove from the `authorized_keys` file.", + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "ghes-delete-ssh-response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname", + "description": "Hostname of the node where the SSH key was removed." + }, + "uuid": { + "type": "string", + "format": "uuid", + "description": "UUID of the SSH key that was removed." + }, + "message": { + "type": "string", + "description": "Message indicating the result of the SSH key removal." + }, + "error": { + "type": "string", + "description": "Error message indicating the reason for the SSH key removal failure. This field is only present if the SSH key removal failed." + } + } + } + }, + "ghes-checks-result-indicator": { + "type": "string", + "enum": [ + "OK", + "FAILED" + ] + }, + "ghes-checks-system-requirements": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "roles_status": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-checks-result-indicator" + }, + "role": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "ghes-cluster-status-indicator": { + "type": "string", + "enum": [ + "UNKNOWN", + "OK", + "WARNING", + "CRITICAL" + ] + }, + "ghes-cluster-status": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string" + }, + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + }, + "name": { + "type": "string" + }, + "details": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "ghes-config-init-request": { + "title": "Initialize configuration with license upload", + "type": "object", + "properties": { + "license": { + "type": "string", + "description": "The content of your _.ghl_ license file." + }, + "password": { + "type": "string", + "description": "The root site administrator password." + } + }, + "required": [ + "license", + "password" + ] + }, + "ghes-license-info": { + "type": "object", + "properties": { + "advancedSecurityEnabled": { + "description": "Whether the GitHub Advanced Security feature is enabled.", + "type": "boolean" + }, + "advancedSecuritySeats": { + "description": "If the GitHub Advanced Security feature is enabled, the seat count.", + "type": "integer" + }, + "clusterSupport": { + "description": "Whether the cluster support feature is enabled.", + "type": "boolean" + }, + "company": { + "description": "The company under which the license is issued.", + "type": "string" + }, + "croquetSupport": { + "description": "Whether the Github Connect feature is enabled.", + "type": "boolean" + }, + "customTerms": { + "description": "Whether this license is issued under custom terms.", + "type": "boolean" + }, + "evaluation": { + "description": "Wheter this license is issued as an evaluation license.", + "type": "boolean" + }, + "expireAt": { + "description": "The expiration date of the license.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "insightsEnabled": { + "description": "Whether the insights feature is enabled.", + "type": "boolean" + }, + "insightsExpireAt": { + "description": "If the insights feature is enabled, the expiration date.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "learningLabEvaluationExpires": { + "description": "If the learning lab feature is enabled, the expiration date.", + "type": "string", + "format": "date-time", + "example": "2025-01-02T07:59:59Z" + }, + "learningLabSeats": { + "description": "If the learning lab feature is enabled, the seat count.", + "type": "integer" + }, + "perpetual": { + "description": "Whether the perpetual feature is enabled.", + "type": "boolean" + }, + "referenceNumber": { + "description": "The unique reference number of the license.", + "type": "string" + }, + "seats": { + "description": "If the license is issued with limited seating, the seat count.", + "type": "integer" + }, + "sshAllowed": { + "description": "Whether the SSH feature is enabled.", + "type": "boolean" + }, + "supportKey": { + "description": "The support key of the license.", + "type": "string" + }, + "unlimitedSeating": { + "description": "Whether the license is issued with unlimited seat count.", + "type": "boolean" + } + } + }, + "ghes-upload-license-request": { + "title": "License upload form", + "type": "object", + "properties": { + "license": { + "type": "string", + "description": "The content of your _.ghl_ license file." + } + }, + "required": [ + "license" + ] + }, + "ghes-license-check": { + "type": "object", + "properties": { + "status": { + "description": "The license status of the currently active enterprise license.", + "type": "string", + "enum": [ + "valid", + "invalid", + "expired", + "cluster mode not supported" + ] + } + } + }, "ghes-cluster-topology": { "type": "string", "enum": [ @@ -92968,6 +101969,542 @@ } } }, + "ghes-get-settings": { + "type": "object", + "properties": { + "private_mode": { + "type": "boolean" + }, + "public_pages": { + "type": "boolean" + }, + "subdomain_isolation": { + "type": "boolean" + }, + "signup_enabled": { + "type": "boolean" + }, + "github_hostname": { + "type": "string" + }, + "identicons_host": { + "type": "string" + }, + "http_proxy": { + "nullable": true, + "type": "string" + }, + "auth_mode": { + "type": "string" + }, + "expire_sessions": { + "type": "boolean" + }, + "admin_password": { + "nullable": true, + "type": "string" + }, + "configuration_id": { + "type": "integer" + }, + "configuration_run_count": { + "type": "integer" + }, + "avatar": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "uri": { + "type": "string" + } + } + }, + "customer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "secret_key_data": { + "type": "string" + }, + "public_key_data": { + "type": "string" + } + } + }, + "license": { + "type": "object", + "properties": { + "seats": { + "type": "integer" + }, + "evaluation": { + "type": "boolean" + }, + "perpetual": { + "type": "boolean" + }, + "unlimited_seating": { + "type": "boolean" + }, + "support_key": { + "type": "string" + }, + "ssh_allowed": { + "type": "boolean" + }, + "cluster_support": { + "type": "boolean" + }, + "expire_at": { + "type": "string" + } + } + }, + "github_ssl": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "cert": { + "nullable": true, + "type": "string" + }, + "key": { + "nullable": true, + "type": "string" + } + } + }, + "ldap": { + "type": "object", + "properties": { + "host": { + "nullable": true, + "type": "string" + }, + "port": { + "type": "integer" + }, + "base": { + "type": "array", + "items": { + "type": "string" + } + }, + "uid": { + "nullable": true, + "type": "string" + }, + "bind_dn": { + "nullable": true, + "type": "string" + }, + "password": { + "nullable": true, + "type": "string" + }, + "method": { + "type": "string" + }, + "search_strategy": { + "type": "string" + }, + "user_groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "admin_group": { + "nullable": true, + "type": "string" + }, + "virtual_attribute_enabled": { + "type": "boolean" + }, + "recursive_group_search": { + "type": "boolean" + }, + "posix_support": { + "type": "boolean" + }, + "user_sync_emails": { + "type": "boolean" + }, + "user_sync_keys": { + "type": "boolean" + }, + "user_sync_interval": { + "type": "integer" + }, + "team_sync_interval": { + "type": "integer" + }, + "sync_enabled": { + "type": "boolean" + }, + "reconciliation": { + "type": "object", + "properties": { + "user": { + "nullable": true, + "type": "string" + }, + "org": { + "nullable": true, + "type": "string" + } + } + }, + "profile": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, + "mail": { + "nullable": true, + "type": "string" + }, + "key": { + "nullable": true, + "type": "string" + } + } + } + } + }, + "cas": { + "type": "object", + "properties": { + "url": { + "nullable": true, + "type": "string" + } + } + }, + "saml": { + "type": "object", + "properties": { + "sso_url": { + "nullable": true, + "type": "string" + }, + "certificate": { + "nullable": true, + "type": "string" + }, + "certificate_path": { + "nullable": true, + "type": "string" + }, + "issuer": { + "nullable": true, + "type": "string" + }, + "idp_initiated_sso": { + "type": "boolean" + }, + "disable_admin_demote": { + "type": "boolean" + } + } + }, + "github_oauth": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + }, + "organization_name": { + "type": "string" + }, + "organization_team": { + "type": "string" + } + } + }, + "smtp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "address": { + "type": "string" + }, + "authentication": { + "type": "string" + }, + "port": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "username": { + "type": "string" + }, + "user_name": { + "type": "string" + }, + "enable_starttls_auto": { + "type": "boolean" + }, + "password": { + "type": "string" + }, + "discard-to-noreply-address": { + "type": "boolean" + }, + "support_address": { + "type": "string" + }, + "support_address_type": { + "type": "string" + }, + "noreply_address": { + "type": "string" + } + } + }, + "ntp": { + "type": "object", + "properties": { + "primary_server": { + "type": "string" + }, + "secondary_server": { + "type": "string" + } + } + }, + "timezone": { + "nullable": true, + "type": "string" + }, + "snmp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "community": { + "type": "string" + } + } + }, + "syslog": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "nullable": true, + "type": "string" + }, + "protocol_name": { + "type": "string" + } + } + }, + "assets": { + "nullable": true, + "type": "string" + }, + "pages": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "collectd": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "nullable": true, + "type": "string" + }, + "port": { + "type": "integer" + }, + "encryption": { + "nullable": true, + "type": "string" + }, + "username": { + "nullable": true, + "type": "string" + }, + "password": { + "nullable": true, + "type": "string" + } + } + }, + "mapping": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "tileserver": { + "nullable": true, + "type": "string" + }, + "basemap": { + "type": "string" + }, + "token": { + "nullable": true, + "type": "string" + } + } + }, + "load_balancer": { + "nullable": true, + "type": "string" + } + } + }, + "ghes-get-maintenance": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname" + }, + "uuid": { + "type": "string", + "format": "uuid" + }, + "status": { + "type": "string", + "enum": [ + "on", + "off", + "scheduled" + ] + }, + "scheduled_time": { + "type": "string", + "format": "date" + }, + "connection_services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "number": { + "type": "integer" + } + } + } + }, + "can_unset_maintenance": { + "type": "boolean" + }, + "ip_exception_list": { + "type": "array", + "items": { + "type": "string", + "format": "ip/cidr" + } + }, + "maintenance_mode_message": { + "type": "string" + } + } + } + }, + "ghes-set-maintenance-request": { + "title": "Set Maintenance mode", + "type": "object", + "properties": { + "enabled": { + "description": "Whether to enable maintenance mode.", + "type": "boolean" + }, + "uuid": { + "description": "The UUID of the node to target. This parameter is incompatible with maintenance mode scheduling. Only use `uuid` if the value of `when` is empty or `now`.", + "type": "string", + "format": "uuid" + }, + "when": { + "description": "The time to enable maintenance mode. If this parameter is empty or set to `now`, maintenance mode is enabled immediately. Otherwise, maintenance mode is enabled at the specified time. The format is ISO 8601.", + "type": "string", + "format": "date-time", + "example": "2006-01-02T15:04:05+00:00" + }, + "ip_exception_list": { + "description": "The list of IP addresses to exclude from maintenance mode. IPv4, IPv6, and CIDR addresses are supported.", + "type": "array", + "items": { + "type": "string", + "format": "ip/cidr" + }, + "example": "[\"1.1.1.1\",\"192.168.1.0/24\"]" + }, + "maintenance_mode_message": { + "description": "The message to display to users when maintenance mode is enabled.", + "type": "string" + } + }, + "required": [ + "enabled" + ] + }, + "ghes-set-maintenance-response": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname" + }, + "uuid": { + "type": "string", + "format": "uuid" + }, + "message": { + "type": "string" + }, + "error": { + "type": "string" + } + } + } + }, "ghes-replication-status-indicator": { "type": "string", "enum": [ @@ -93074,15 +102611,6 @@ "192.0.2.1" ] }, - "dependabot": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "192.0.2.1" - ] - }, "domains": { "type": "object", "properties": { @@ -93130,12 +102658,55 @@ "example.com" ] } + }, + "actions_inbound": { + "type": "object", + "properties": { + "full_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "wildcard_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + }, + "artifact_attestations": { + "type": "object", + "properties": { + "trust_domain": { + "type": "string", + "example": [ + "example" + ] + }, + "services": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } } } }, "installed_version": { "type": "string", - "example": "3.9.0" + "example": "3.15.0" } }, "required": [ @@ -93158,6 +102729,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -93181,6 +102766,18 @@ ] } } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } }, @@ -93191,6 +102788,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -93927,7 +103525,8 @@ "collaborators": { "type": "integer", "example": 8, - "nullable": true + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." }, "billing_email": { "type": "string", @@ -94014,32 +103613,38 @@ "advanced_security_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", "example": false, - "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role." + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { "type": "boolean", @@ -94060,6 +103665,11 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ @@ -94398,6 +104008,222 @@ "error" ] }, + "code-security-configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "code-security-default-configurations": { + "type": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + } + }, + "code-security-configuration-repositories": { + "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + } + } + }, "organization-custom-repository-role-create-schema": { "type": "object", "properties": { @@ -94533,6 +104359,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -95349,6 +105176,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 79 }, "owner": { @@ -95441,6 +105269,569 @@ "updated_at" ] }, + "organization-fine-grained-permission": { + "title": "Organization Fine-Grained Permission", + "description": "A fine-grained permission that protects organization resources.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "name", + "description" + ] + }, + "organization-role": { + "title": "Organization Role", + "description": "Organization roles", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the role.", + "type": "string" + }, + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": "string", + "nullable": true + }, + "base_role": { + "type": "string", + "nullable": true, + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin" + ] + }, + "source": { + "type": "string", + "nullable": true, + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined" + ] + }, + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "description": "The date and time the role was created.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time the role was last updated.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "organization-custom-organization-role-create-schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the custom role.", + "type": "string" + }, + "description": { + "description": "A short description about the intended usage of this role or what permissions it grants.", + "type": "string" + }, + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "base_role": { + "description": "The system role from which this role can inherit permissions.", + "type": "string", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin" + ] + } + }, + "required": [ + "name", + "permissions" + ] + }, + "organization-custom-organization-role-update-schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the custom role.", + "type": "string" + }, + "description": { + "description": "A short description about the intended use of this role or the permissions it grants.", + "type": "string" + }, + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "base_role": { + "description": "The system role from which this role can inherit permissions.", + "type": "string", + "enum": [ + "none", + "read", + "triage", + "write", + "maintain", + "admin" + ] + } + } + }, + "nullable-team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + }, + "team-role-assignment": { + "title": "A Role Assignment for a Team", + "description": "The Relationship a Team has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + }, + "user-role-assignment": { + "title": "A Role Assignment for a User", + "description": "The Relationship a User has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "inherited_from": { + "description": "Team the user has gotten the role through", + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, "package-version": { "title": "Package Version", "description": "A version of a software package", @@ -95551,6 +105942,192 @@ "updated_at" ] }, + "organization-programmatic-access-grant-request": { + "title": "Simple Organization Programmatic Access Grant Request", + "description": "Minimal representation of an organization programmatic access grant request for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." + }, + "reason": { + "type": "string", + "nullable": true, + "description": "Reason for requesting access." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "reason", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + }, + "organization-programmatic-access-grant": { + "title": "Organization Programmatic Access Grant", + "description": "Minimal representation of an organization programmatic access grant for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "access_granted_at": { + "type": "string", + "description": "Date and time when the fine-grained personal access token was approved to access the organization." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "access_granted_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + }, "org-pre-receive-hook": { "type": "object", "properties": { @@ -95668,6 +106245,207 @@ "updated_at" ] }, + "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" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "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": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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" + ] + }, "nullable-repository": { "title": "Repository", "description": "A repository on GitHub.", @@ -95676,7 +106454,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -96077,7 +106856,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -96264,6 +107043,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 1296269 }, "node_id": { @@ -96731,6 +107511,11 @@ }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -96828,162 +107613,1311 @@ "description" ] }, - "team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "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 not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "repository-ruleset-bypass-actor": { + "title": "Repository Ruleset Bypass Actor", "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], "properties": { - "id": { - "description": "Unique identifier of the team", + "actor_id": { "type": "integer", - "example": 1 + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, - "node_id": { + "actor_type": { "type": "string", - "example": "MDQ6VGVhbTE=" + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset" }, - "url": { - "description": "URL for the team", + "bypass_mode": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + }, + "repository-ruleset-conditions": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + "repository-ruleset-conditions-repository-name-target": { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + "repository-ruleset-conditions-repository-id-target": { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + }, + "repository-ruleset-conditions-repository-property-spec": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "description": "The name of the repository property to target" }, - "name": { - "description": "Name of the team", + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { "type": "string", - "example": "Justice League" + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + }, + "repository-ruleset-conditions-repository-property-target": { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + "org-ruleset-conditions": { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + } + ] }, - "description": { - "description": "Description of the team", + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + } + ] + } + ] + }, + "repository-rule-creation": { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "nullable": true, - "example": "A great team." + "enum": [ + "creation" + ] + } + } + }, + "repository-rule-update": { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + "repository-rule-deletion": { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "example": "admin" + "enum": [ + "deletion" + ] + } + } + }, + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] }, - "privacy": { - "description": "The level of privacy this team should have", + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + "repository-rule-required-deployments": { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "example": "closed" + "enum": [ + "required_deployments" + ] }, - "html_url": { + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + "repository-rule-required-signatures": { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "enum": [ + "required_signatures" + ] + } + } + }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } }, - "repositories_url": { + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, + "repository-rule-pull-request": { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] }, - "slug": { + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + "repository-rule-params-status-check-configuration": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { "type": "string", - "example": "justice-league" + "description": "The status check context name that must be present on the commit." }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." } }, "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "context" ] }, - "nullable-team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "repository-rule-required-status-checks": { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] }, - "node_id": { + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + "repository-rule-non-fast-forward": { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "example": "MDQ6VGVhbTE=" + "enum": [ + "non_fast_forward" + ] + } + } + }, + "repository-rule-commit-message-pattern": { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] }, - "url": { - "description": "URL for the team", + "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-commit-author-email-pattern": { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "enum": [ + "commit_author_email_pattern" + ] }, - "members_url": { + "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-committer-email-pattern": { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "enum": [ + "committer_email_pattern" + ] }, - "name": { - "description": "Name of the team", + "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-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", - "example": "Justice League" + "enum": [ + "branch_name_pattern" + ] }, - "description": { - "description": "Description of the team", + "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", - "nullable": true, - "example": "A great team." + "enum": [ + "tag_name_pattern" + ] }, - "permission": { - "description": "Permission that the team will have for its repositories", + "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", + "properties": { + "path": { "type": "string", - "example": "admin" + "description": "The path to the workflow file" }, - "privacy": { - "description": "The level of privacy this team should have", + "ref": { "type": "string", - "example": "closed" + "description": "The ref (branch or tag) of the workflow file to use" }, - "html_url": { + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "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" + ] }, - "repositories_url": { + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] }, - "slug": { + "security_alerts_threshold": { "type": "string", - "example": "justice-league" + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "tool": { + "type": "string", + "description": "The name of a code scanning tool" } }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + }, + "repository-rule-code-scanning": { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + "repository-rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + } + ] + }, + "repository-ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", "required": [ "id", - "node_id", - "url", - "members_url", "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "source", + "enforcement" ], - "nullable": true + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset.", + "enum": [ + "branch", + "tag", + "push" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ] + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "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.", + "nullable": true + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account.", + "nullable": true + }, + "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", + "nullable": true, + "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`. Null if no rules with `evaluate` enforcement status were run." + }, + "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", + "nullable": true, + "description": "The detailed failure message for the rule. Null if the rule passed." + } + } + } + } + } }, "team": { "title": "Team", @@ -97009,6 +108943,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -97307,6 +109244,11 @@ "updated_at": { "type": "string", "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true } }, "required": [ @@ -97383,6 +109325,15 @@ ], "example": "closed" }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, "permission": { "description": "Permission that the team will have for its repositories", "example": "push", @@ -98323,7 +110274,8 @@ "id": { "description": "The project card's ID", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -98517,6 +110469,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -99062,7 +111017,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "number": { "type": "integer" @@ -99083,7 +111039,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -99118,7 +111075,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -99509,6 +111467,48 @@ "comment" ] }, + "review-custom-gates-comment-required": { + "type": "object", + "properties": { + "environment_name": { + "type": "string", + "description": "The name of the environment to approve or reject." + }, + "comment": { + "type": "string", + "description": "Comment associated with the pending deployment protection rule. **Required when state is not provided.**" + } + }, + "required": [ + "environment_name", + "comment" + ] + }, + "review-custom-gates-state-required": { + "type": "object", + "properties": { + "environment_name": { + "type": "string", + "description": "The name of the environment to approve or reject." + }, + "state": { + "type": "string", + "description": "Whether to approve or reject deployment to the specified environments.", + "enum": [ + "approved", + "rejected" + ] + }, + "comment": { + "type": "string", + "description": "Optional comment to include with the review." + } + }, + "required": [ + "environment_name", + "state" + ] + }, "deployment-reviewer-type": { "type": "string", "description": "The type of reviewer.", @@ -99528,8 +111528,9 @@ "properties": { "id": { "description": "The id of the environment.", - "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 56780428 }, "node_id": { "type": "string", @@ -99610,8 +111611,9 @@ }, "id": { "description": "Unique identifier of the deployment", - "example": 42, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 42 }, "node_id": { "type": "string", @@ -99783,6 +111785,68 @@ "updated_at" ] }, + "activity": { + "title": "Activity", + "description": "Activity", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "before": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "description": "The SHA of the commit before the activity." + }, + "after": { + "type": "string", + "example": "827efc6d56897b048c772eb4087f854f46256132", + "description": "The SHA of the commit after the activity." + }, + "ref": { + "type": "string", + "example": "refs/heads/main", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "The time when the activity occurred." + }, + "activity_type": { + "type": "string", + "example": "force_push", + "enum": [ + "push", + "force_push", + "branch_deletion", + "branch_creation", + "pr_merge", + "merge_queue_merge" + ], + "description": "The type of the activity that was performed." + }, + "actor": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "id", + "node_id", + "before", + "after", + "ref", + "timestamp", + "activity_type", + "actor" + ] + }, "autolink": { "title": "Autolink reference", "description": "An autolink reference.", @@ -99815,6 +111879,27 @@ "is_alphanumeric" ] }, + "check-automated-security-fixes": { + "title": "Check Automated Security Fixes", + "description": "Check Automated Security Fixes", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "example": true, + "description": "Whether automated security fixes are enabled for the repository." + }, + "paused": { + "type": "boolean", + "example": false, + "description": "Whether automated security fixes are paused for the repository." + } + }, + "required": [ + "enabled", + "paused" + ] + }, "protected-branch-required-status-check": { "title": "Protected Branch Required Status Check", "description": "Protected Branch Required Status Check", @@ -100014,7 +112099,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -100063,6 +112149,9 @@ }, "site_admin": { "type": "boolean" + }, + "user_view_type": { + "type": "string" } } } @@ -100097,6 +112186,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -100209,12 +112301,19 @@ "site_admin": { "type": "boolean", "example": false + }, + "user_view_type": { + "type": "string", + "example": "public" } } }, "name": { "type": "string" }, + "client_id": { + "type": "string" + }, "description": { "type": "string" }, @@ -100621,10 +112720,26 @@ ] }, "author": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "committer": { - "$ref": "#/components/schemas/nullable-simple-user" + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] }, "parents": { "type": "array", @@ -101119,7 +113234,8 @@ "id": { "description": "The id of the check.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "head_sha": { "description": "The SHA of the commit that is being checked.", @@ -101419,7 +113535,8 @@ "properties": { "id": { "type": "integer", - "example": 5 + "example": 5, + "format": "int64" }, "node_id": { "type": "string", @@ -101681,7 +113798,7 @@ }, "full_description": { "type": "string", - "description": "description of the rule used to detect the alert." + "description": "A description of the rule used to detect the alert." }, "tags": { "nullable": true, @@ -101918,6 +114035,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -101945,6 +114063,14 @@ "type": "string", "format": "date-time", "example": "2023-12-06T14:20:20.000Z" + }, + "schedule": { + "description": "The frequency of the periodic analysis.", + "nullable": true, + "type": "string", + "enum": [ + "weekly" + ] } } }, @@ -101967,12 +114093,27 @@ "default", "extended" ] + }, + "languages": { + "description": "CodeQL languages to be analyzed.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "actions", + "c-cpp", + "csharp", + "go", + "java-kotlin", + "javascript-typescript", + "python", + "ruby", + "swift" + ] + } } }, - "additionalProperties": true, - "required": [ - "state" - ] + "additionalProperties": false }, "code-scanning-default-setup-update-response": { "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.", @@ -101995,7 +114136,7 @@ "example": "refs/heads/main" }, "code-scanning-analysis-sarif-file": { - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.9/code-security/secure-coding/sarif-support-for-code-scanning).\"", + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.15/code-security/secure-coding/sarif-support-for-code-scanning).\"", "type": "string" }, "code-scanning-sarifs-receipt": { @@ -102042,6 +114183,29 @@ } } }, + "code-security-configuration-for-repository": { + "type": "object", + "description": "Code security configuration associated with a repository and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, "codeowners-errors": { "title": "CODEOWNERS errors", "description": "A list of errors found in a repo's CODEOWNERS file", @@ -102114,6 +114278,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -102224,6 +114389,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -102258,6 +114427,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "email": { @@ -102368,6 +114538,10 @@ "role_name": { "type": "string", "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" } }, "required": [ @@ -102577,6 +114751,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -103152,6 +115327,9 @@ "sha": { "type": "string" }, + "content": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -103188,9 +115366,6 @@ "path": { "type": "string" }, - "content": { - "type": "string" - }, "sha": { "type": "string" }, @@ -103287,9 +115462,7 @@ "sha", "size", "type", - "url", - "content", - "encoding" + "url" ] }, "content-directory": { @@ -103799,6 +115972,49 @@ } } }, + "secret-scanning-push-protection-bypass-placeholder-id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "repository-rule-violation-error": { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, "contributor": { "title": "Contributor", "description": "Contributor", @@ -103875,6 +116091,9 @@ }, "name": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -104134,6 +116353,11 @@ "example": "SPDX-2.3", "description": "The version of the SPDX specification that this document conforms to." }, + "comment": { + "type": "string", + "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/", + "description": "An optional comment about the SPDX document." + }, "creationInfo": { "type": "object", "properties": { @@ -104166,17 +116390,9 @@ "example": "CC0-1.0", "description": "The license under which the SPDX document is licensed." }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "example": "github/github" - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", - "example": "https://github.com/example/dependency_graph/sbom-123", + "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "description": "The namespace for the SPDX document." }, "packages": { @@ -104191,7 +116407,7 @@ }, "name": { "type": "string", - "example": "rubygems:github/github", + "example": "github/github", "description": "The name of the package." }, "versionInfo": { @@ -104224,6 +116440,11 @@ "example": "NOASSERTION", "description": "The distribution source of this package, or NOASSERTION if this was not determined." }, + "copyrightText": { + "type": "string", + "example": "Copyright (c) 1985 GitHub.com", + "description": "The copyright holders of the package, and any dates present with those notices, if available." + }, "externalRefs": { "type": "array", "items": { @@ -104259,10 +116480,33 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "licenseConcluded", - "licenseDeclared", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "example": "DEPENDS_ON", + "description": "The type of relationship between the two SPDX elements." + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -104272,7 +116516,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -104491,6 +116734,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -104528,7 +116772,7 @@ "example": "production" }, "target_url": { - "description": "Deprecated: the URL to associate with this status.", + "description": "Closing down notice: the URL to associate with this status.", "default": "", "type": "string", "format": "uri", @@ -104618,7 +116862,8 @@ "id": { "description": "The id of the environment.", "example": 56780428, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -104690,6 +116935,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" @@ -104762,13 +117012,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 }, @@ -104777,9 +117032,18 @@ "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" + ] } } }, @@ -104791,6 +117055,15 @@ "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": [ @@ -104811,6 +117084,70 @@ "name" ] }, + "custom-deployment-rule-app": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515, + "description": "The unique identifier of the deployment protection rule integration." + }, + "slug": { + "type": "string", + "example": "my-custom-app", + "description": "The slugified name of the deployment protection rule integration." + }, + "integration_url": { + "type": "string", + "example": "https://api.github.com/apps/custom-app-slug", + "description": "The URL for the endpoint to get details about the app." + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=", + "description": "The node ID for the deployment protection rule integration." + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + }, + "deployment-protection-rule": { + "title": "Deployment protection rule", + "description": "Deployment protection rule", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515, + "description": "The unique identifier for the deployment protection rule." + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=", + "description": "The node ID for the deployment protection rule." + }, + "enabled": { + "type": "boolean", + "example": true, + "description": "Whether the deployment protection rule is enabled for the environment." + }, + "app": { + "$ref": "#/components/schemas/custom-deployment-rule-app" + } + }, + "required": [ + "id", + "node_id", + "enabled", + "app" + ] + }, "short-blob": { "title": "Short Blob", "description": "Short Blob", @@ -105369,7 +117706,8 @@ "id": { "description": "Unique identifier of the repository invitation.", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "repository": { "$ref": "#/components/schemas/minimal-repository" @@ -105642,6 +117980,9 @@ }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" } }, "required": [ @@ -106901,6 +119242,7 @@ "type": "object", "properties": { "id": { + "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "example": 208045946 @@ -106921,6 +119263,7 @@ "type": "string" }, "description": { + "description": "Optional description of the label, such as its purpose.", "type": "string", "example": "Something isn't working", "nullable": true @@ -106931,6 +119274,7 @@ "type": "string" }, "default": { + "description": "Whether this label comes by default in a new repository.", "type": "boolean", "example": true } @@ -107346,14 +119690,16 @@ }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", - "example": 42, "type": "integer", + "format": "int64", + "example": 42, "nullable": true }, "id": { "description": "The ID of the pull request review comment.", - "example": 1, - "type": "integer" + "type": "integer", + "format": "int64", + "example": 1 }, "node_id": { "description": "The node ID of the pull request review comment.", @@ -107371,12 +119717,12 @@ "type": "string" }, "position": { - "description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.", + "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", "example": 1, "type": "integer" }, "original_position": { - "description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.", + "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", "example": 4, "type": "integer" }, @@ -108327,11 +120673,22 @@ "description": "The GitHub Pages deployment status.", "type": "object", "properties": { + "id": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit." + }, "status_url": { "type": "string", "description": "The URI to monitor GitHub Pages deployment status.", "format": "uri", - "example": "https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251" + "example": "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" }, "page_url": { "type": "string", @@ -108347,10 +120704,34 @@ } }, "required": [ + "id", "status_url", "page_url" ] }, + "pages-deployment-status": { + "title": "GitHub Pages deployment status", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the deployment.", + "enum": [ + "deployment_in_progress", + "syncing_files", + "finished_file_sync", + "updating_pages", + "purging_cdn", + "deployment_cancelled", + "deployment_failed", + "deployment_content_failed", + "deployment_attempt_error", + "deployment_lost", + "succeed" + ] + } + } + }, "repository-pre-receive-hook": { "type": "object", "properties": { @@ -108380,6 +120761,7 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, "node_id": { @@ -108441,725 +120823,142 @@ "open", "closed" ], - "example": "open", - "type": "string" - }, - "locked": { - "type": "boolean", - "example": true - }, - "title": { - "description": "The title of the pull request.", - "example": "Amazing new feature", - "type": "string" - }, - "user": { - "$ref": "#/components/schemas/simple-user" - }, - "body": { - "type": "string", - "example": "Please pull these awesome changes", - "nullable": true - }, - "labels": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string" - }, - "default": { - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } - }, - "milestone": { - "$ref": "#/components/schemas/nullable-milestone" - }, - "active_lock_reason": { - "type": "string", - "example": "too heated", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "merged_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "merge_commit_sha": { - "type": "string", - "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "nullable": true - }, - "assignee": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "requested_reviewers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - }, - "nullable": true - }, - "requested_teams": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-simple" - }, - "nullable": true - }, - "head": { - "type": "object", - "properties": { - "label": { - "type": "string" - }, - "ref": { - "type": "string" - }, - "repo": { - "type": "object", - "nullable": true, - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "spdx_id": { - "type": "string", - "nullable": true - }, - "node_id": { - "type": "string" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ], - "nullable": true - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "is_template": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "example": "open", + "type": "string" + }, + "locked": { + "type": "boolean", + "example": true + }, + "title": { + "description": "The title of the pull request.", + "example": "Amazing new feature", + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "body": { + "type": "string", + "example": "Please pull these awesome changes", + "nullable": true + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "active_lock_reason": { + "type": "string", + "example": "too heated", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merged_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merge_commit_sha": { + "type": "string", + "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "nullable": true + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true + }, + "requested_teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + }, + "nullable": true + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -109180,567 +120979,13 @@ "type": "string" }, "repo": { - "type": "object", - "properties": { - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string", - "format": "uri" - }, - "deployments_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": "string", - "nullable": true - }, - "downloads_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "fork": { - "type": "boolean" - }, - "forks_url": { - "type": "string", - "format": "uri" - }, - "full_name": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "node_id": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string", - "format": "uri" - }, - "merges_url": { - "type": "string", - "format": "uri" - }, - "milestones_url": { - "type": "string" - }, - "name": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "private": { - "type": "boolean" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string", - "format": "uri" - }, - "subscription_url": { - "type": "string", - "format": "uri" - }, - "tags_url": { - "type": "string", - "format": "uri" - }, - "teams_url": { - "type": "string", - "format": "uri" - }, - "trees_url": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "clone_url": { - "type": "string" - }, - "default_branch": { - "type": "string" - }, - "forks": { - "type": "integer" - }, - "forks_count": { - "type": "integer" - }, - "git_url": { - "type": "string" - }, - "has_downloads": { - "type": "boolean" - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "homepage": { - "type": "string", - "format": "uri", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "master_branch": { - "type": "string" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "open_issues": { - "type": "integer" - }, - "open_issues_count": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "license": { - "$ref": "#/components/schemas/nullable-license-simple" - }, - "pushed_at": { - "type": "string", - "format": "date-time" - }, - "size": { - "type": "integer" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_count": { - "type": "integer" - }, - "svn_url": { - "type": "string", - "format": "uri" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "watchers": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "login": { - "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" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -109948,7 +121193,8 @@ "id": { "description": "Unique identifier of the review", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -110052,11 +121298,13 @@ }, "pull_request_review_id": { "type": "integer", + "format": "int64", "example": 42, "nullable": true }, "id": { "type": "integer", + "format": "int64", "example": 10 }, "node_id": { @@ -110421,6 +121669,205 @@ "body" ] }, + "repository-rule-ruleset-info": { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + }, + "repository-rule-detailed": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule with ruleset details.", + "oneOf": [ + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + } + ] + }, "secret-scanning-alert": { "type": "object", "properties": { @@ -110470,7 +121917,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "secret": { "type": "string", @@ -110489,6 +121936,15 @@ "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } }, @@ -110553,6 +122009,64 @@ "commit_url" ] }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, "secret-scanning-location-issue-title": { "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", "type": "object", @@ -110651,7 +122165,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -110666,7 +122180,7 @@ "type": "string", "format": "uri", "description": "The API URL to get the pull request where the secret was detected.", - "example": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, "required": [ @@ -110725,6 +122239,7 @@ "type": "string", "enum": [ "commit", + "wiki_commit", "issue_title", "issue_body", "issue_comment", @@ -110745,6 +122260,9 @@ { "$ref": "#/components/schemas/secret-scanning-location-commit" }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, { "$ref": "#/components/schemas/secret-scanning-location-issue-title" }, @@ -110780,12 +122298,35 @@ } ] } - }, - "required": [ - "type", - "details" + } + }, + "secret-scanning-push-protection-bypass-reason": { + "description": "The reason for bypassing push protection.", + "type": "string", + "enum": [ + "false_positive", + "used_in_tests", + "will_fix_later" ] }, + "secret-scanning-push-protection-bypass": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "expire_at": { + "type": "string", + "format": "date-time", + "description": "The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "token_type": { + "type": "string", + "description": "The token type this bypass is for." + } + } + }, "stargazer": { "title": "Stargazer", "description": "Stargazer", @@ -112022,6 +123563,26 @@ } } }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "type": "string" }, @@ -112729,7 +124290,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string" @@ -112847,6 +124409,9 @@ "type": "string", "format": "date-time", "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -112871,501 +124436,6 @@ "score" ] }, - "configuration-status": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "progress": { - "type": "array", - "items": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "key": { - "type": "string" - } - }, - "required": [ - "status", - "key" - ] - } - } - } - }, - "maintenance-status": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "scheduled_time": { - "type": "string" - }, - "connection_services": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "number": { - "type": "integer" - } - }, - "required": [ - "name", - "number" - ] - } - } - } - }, - "enterprise-settings": { - "type": "object", - "properties": { - "enterprise": { - "type": "object", - "properties": { - "private_mode": { - "type": "boolean" - }, - "public_pages": { - "type": "boolean" - }, - "subdomain_isolation": { - "type": "boolean" - }, - "signup_enabled": { - "type": "boolean" - }, - "github_hostname": { - "type": "string" - }, - "identicons_host": { - "type": "string" - }, - "http_proxy": { - "nullable": true, - "type": "string" - }, - "auth_mode": { - "type": "string" - }, - "expire_sessions": { - "type": "boolean" - }, - "admin_password": { - "nullable": true, - "type": "string" - }, - "configuration_id": { - "type": "integer" - }, - "configuration_run_count": { - "type": "integer" - }, - "avatar": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "uri": { - "type": "string" - } - } - }, - "customer": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - }, - "uuid": { - "type": "string" - }, - "secret_key_data": { - "type": "string" - }, - "public_key_data": { - "type": "string" - } - } - }, - "license": { - "type": "object", - "properties": { - "seats": { - "type": "integer" - }, - "evaluation": { - "type": "boolean" - }, - "perpetual": { - "type": "boolean" - }, - "unlimited_seating": { - "type": "boolean" - }, - "support_key": { - "type": "string" - }, - "ssh_allowed": { - "type": "boolean" - }, - "cluster_support": { - "type": "boolean" - }, - "expire_at": { - "type": "string" - } - } - }, - "github_ssl": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "cert": { - "nullable": true, - "type": "string" - }, - "key": { - "nullable": true, - "type": "string" - } - } - }, - "ldap": { - "type": "object", - "properties": { - "host": { - "nullable": true, - "type": "string" - }, - "port": { - "type": "integer" - }, - "base": { - "type": "array", - "items": {} - }, - "uid": { - "nullable": true, - "type": "string" - }, - "bind_dn": { - "nullable": true, - "type": "string" - }, - "password": { - "nullable": true, - "type": "string" - }, - "method": { - "type": "string" - }, - "search_strategy": { - "type": "string" - }, - "user_groups": { - "type": "array", - "items": {} - }, - "admin_group": { - "nullable": true, - "type": "string" - }, - "virtual_attribute_enabled": { - "type": "boolean" - }, - "recursive_group_search": { - "type": "boolean" - }, - "posix_support": { - "type": "boolean" - }, - "user_sync_emails": { - "type": "boolean" - }, - "user_sync_keys": { - "type": "boolean" - }, - "user_sync_interval": { - "type": "integer" - }, - "team_sync_interval": { - "type": "integer" - }, - "sync_enabled": { - "type": "boolean" - }, - "reconciliation": { - "type": "object", - "properties": { - "user": { - "nullable": true, - "type": "string" - }, - "org": { - "nullable": true, - "type": "string" - } - } - }, - "profile": { - "type": "object", - "properties": { - "uid": { - "type": "string" - }, - "name": { - "nullable": true, - "type": "string" - }, - "mail": { - "nullable": true, - "type": "string" - }, - "key": { - "nullable": true, - "type": "string" - } - } - } - } - }, - "cas": { - "type": "object", - "properties": { - "url": { - "nullable": true, - "type": "string" - } - } - }, - "saml": { - "type": "object", - "properties": { - "sso_url": { - "nullable": true, - "type": "string" - }, - "certificate": { - "nullable": true, - "type": "string" - }, - "certificate_path": { - "nullable": true, - "type": "string" - }, - "issuer": { - "nullable": true, - "type": "string" - }, - "idp_initiated_sso": { - "type": "boolean" - }, - "disable_admin_demote": { - "type": "boolean" - } - } - }, - "github_oauth": { - "type": "object", - "properties": { - "client_id": { - "type": "string" - }, - "client_secret": { - "type": "string" - }, - "organization_name": { - "type": "string" - }, - "organization_team": { - "type": "string" - } - } - }, - "smtp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "address": { - "type": "string" - }, - "authentication": { - "type": "string" - }, - "port": { - "type": "string" - }, - "domain": { - "type": "string" - }, - "username": { - "type": "string" - }, - "user_name": { - "type": "string" - }, - "enable_starttls_auto": { - "type": "boolean" - }, - "password": { - "type": "string" - }, - "discard-to-noreply-address": { - "type": "boolean" - }, - "support_address": { - "type": "string" - }, - "support_address_type": { - "type": "string" - }, - "noreply_address": { - "type": "string" - } - } - }, - "ntp": { - "type": "object", - "properties": { - "primary_server": { - "type": "string" - }, - "secondary_server": { - "type": "string" - } - } - }, - "timezone": { - "nullable": true, - "type": "string" - }, - "snmp": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "community": { - "type": "string" - } - } - }, - "syslog": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "nullable": true, - "type": "string" - }, - "protocol_name": { - "type": "string" - } - } - }, - "assets": { - "nullable": true, - "type": "string" - }, - "pages": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - } - }, - "collectd": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "server": { - "nullable": true, - "type": "string" - }, - "port": { - "type": "integer" - }, - "encryption": { - "nullable": true, - "type": "string" - }, - "username": { - "nullable": true, - "type": "string" - }, - "password": { - "nullable": true, - "type": "string" - } - } - }, - "mapping": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "tileserver": { - "nullable": true, - "type": "string" - }, - "basemap": { - "type": "string" - }, - "token": { - "nullable": true, - "type": "string" - } - } - }, - "load_balancer": { - "nullable": true, - "type": "string" - } - } - }, - "run_list": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ssh-key": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "pretty-print": { - "type": "string" - } - } - }, "private-user": { "title": "Private User", "description": "Private User", @@ -113377,8 +124447,12 @@ }, "id": { "type": "integer", + "format": "int64", "example": 1 }, + "user_view_type": { + "type": "string" + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -113477,6 +124551,12 @@ "example": "octocat@github.com", "nullable": true }, + "notification_email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, "hireable": { "type": "boolean", "nullable": true @@ -113564,11 +124644,6 @@ "private_repos" ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, "business_plus": { "type": "boolean" }, @@ -113654,6 +124729,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "example": 3 }, "name": { @@ -113715,7 +124791,8 @@ "type": "object", "properties": { "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "primary_key_id": { "type": "integer" @@ -113832,7 +124909,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "url": { "type": "string" @@ -113971,7 +125049,7 @@ }, "enterprise-webhooks": { "title": "Enterprise", - "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.9/admin/overview/about-enterprise-accounts).\"\n", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-server@3.15/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { @@ -114039,7 +125117,7 @@ }, "simple-installation": { "title": "Simple Installation", - "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.15/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { "id": { @@ -114139,7 +125217,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -114442,6 +125521,11 @@ "type": "string" } }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "has_issues": { "description": "Whether issues are enabled.", "default": true, @@ -114907,7 +125991,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -115062,7 +126146,7 @@ }, "webhooks_rule": { "title": "branch protection rule", - "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", "type": "object", "properties": { "admin_enforced": { @@ -115120,6 +126204,19 @@ "everyone" ] }, + "lock_branch_enforcement_level": { + "description": "The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone.", + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "lock_allows_fork_sync": { + "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.", + "type": "boolean" + }, "merge_queue_enforcement_level": { "type": "string", "enum": [ @@ -115145,6 +126242,10 @@ "require_code_owner_review": { "type": "boolean" }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, "required_approving_review_count": { "type": "integer" }, @@ -115211,6 +126312,7 @@ "strict_required_status_checks_policy", "signature_requirement_enforcement_level", "linear_history_requirement_enforcement_level", + "lock_branch_enforcement_level", "admin_enforced", "allow_force_pushes_enforcement_level", "allow_deletions_enforcement_level", @@ -115221,124 +126323,249 @@ "authorized_actor_names" ] }, - "simple-user-webhooks": { - "title": "Simple User", - "description": "The GitHub user that triggered the event. This property is included in every webhook payload.", + "exemption-request-push-ruleset-bypass": { + "title": "Push ruleset bypass exemption request data", + "description": "Push rules that are being requested to be bypassed.", "type": "object", "properties": { - "name": { - "nullable": true, - "type": "string" + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "push_ruleset_bypass" + ] }, - "email": { - "nullable": true, - "type": "string" + "data": { + "type": "array", + "description": "The data pertaining to the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset for the rules that were violated" + }, + "ruleset_name": { + "type": "string", + "description": "The name of the ruleset for the rules that were violated" + }, + "total_violations": { + "type": "integer", + "description": "The number of violations" + }, + "rule_type": { + "type": "string", + "description": "The type of rule that was violated" + } + } + } + } + } + }, + "exemption-request-secret-scanning": { + "title": "Secret scanning push protection exemption request data", + "description": "Secret scanning push protections that are being requested to be bypassed.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of request", + "enum": [ + "secret_scanning" + ] }, - "login": { + "data": { + "type": "array", + "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that was detected" + }, + "locations": { + "type": "array", + "description": "The location data of the secret that was detected", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "string", + "description": "The commit SHA where the secret was detected" + }, + "branch": { + "type": "string", + "description": "The branch where the secret was detected" + }, + "path": { + "type": "string", + "description": "The path of the file where the secret was detected" + } + } + } + } + } + } + } + } + }, + "exemption-request-secret-scanning-metadata": { + "title": "Secret Scanning Push Protection Exemption Request Metadata", + "description": "Metadata for a secret scanning push protection exemption request.", + "type": "object", + "properties": { + "label": { "type": "string", - "example": "octocat" + "description": "The label for the secret type" }, + "reason": { + "type": "string", + "description": "The reason for the exemption request", + "enum": [ + "fixed_later", + "false_positive", + "tests" + ] + } + } + }, + "exemption-response": { + "title": "Exemption response", + "description": "A response to an exemption request by a delegated bypasser.", + "type": "object", + "properties": { "id": { "type": "integer", - "example": 1 + "description": "The ID of the exemption response." }, - "node_id": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the user who reviewed the exemption request." + }, + "reviewer_login": { "type": "string", - "example": "MDQ6VXNlcjE=" + "description": "The login of the user who reviewed the exemption request." }, - "avatar_url": { + "status": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "description": "The status of the exemption response.", + "enum": [ + "approved", + "rejected", + "dismissed" + ] }, - "gravatar_id": { + "reviewer_comment": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "description": "The comment the reviewer provided when responding to the exemption request.", "nullable": true }, - "url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "format": "date-time", + "description": "The date and time the exemption request was created." + } + } + }, + "exemption-request": { + "title": "Exemption Request", + "description": "A request from a user to be exempted from a set of rules.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the exemption request." }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "number": { + "type": "integer", + "description": "The number uniquely identifying the exemption request within it's repository." }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "repository_id": { + "type": "integer", + "description": "The ID of the repository the exemption request is for." }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "requester_id": { + "type": "integer", + "description": "The ID of the user who requested the exemption." }, - "gists_url": { + "requester_login": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "description": "The login of the user who requested the exemption." }, - "starred_url": { + "request_type": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "description": "The type of request.", + "enum": [ + "push_ruleset_bypass", + "secret_scanning" + ] }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "exemption_request_data": { + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + }, + { + "$ref": "#/components/schemas/exemption-request-secret-scanning" + } + ] }, - "organizations_url": { + "resource_identifier": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", + "example": "827efc6d56897b048c772eb4087f854f46256132" }, - "repos_url": { + "status": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "description": "The status of the exemption request.", + "enum": [ + "pending", + "rejected", + "cancelled", + "completed" + ] }, - "events_url": { + "requester_comment": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "description": "The comment the requester provided when creating the exemption request.", + "nullable": true }, - "received_events_url": { + "metadata": { + "type": "object", + "description": "Metadata about the exemption request.", + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + } + ] + }, + "expires_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "date-time", + "description": "The date and time the exemption request will expire." }, - "type": { + "created_at": { "type": "string", - "example": "User" + "format": "date-time", + "description": "The date and time the exemption request was created." }, - "site_admin": { - "type": "boolean" + "responses": { + "type": "array", + "description": "The responses to the exemption request.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/exemption-response" + } }, - "starred_at": { + "html_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "description": "The URL to view the exemption request in a browser.", + "format": "uri", + "example": "https://github.com/monalisa/smile/exemptions/1" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + } }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", @@ -115584,11 +126811,11 @@ "type": "string" }, "webhooks_ref_0": { - "description": "The [`git ref`](https://docs.github.com/enterprise-server@3.9/rest/git/refs#get-a-reference) resource.", + "description": "The [`git ref`](https://docs.github.com/enterprise-server@3.15/rest/git/refs#get-a-reference) resource.", "type": "string" }, "webhooks_deploy_key": { - "description": "The [`deploy key`](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "description": "The [`deploy key`](https://docs.github.com/enterprise-server@3.15/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { @@ -115742,6 +126969,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -115930,7 +127160,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -115975,6 +127206,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -116121,7 +127355,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -116166,6 +127401,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -116287,6 +127525,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -116510,8 +127751,233 @@ "format": "uri" }, "id": { + "type": "integer", + "format": "int64" + }, + "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" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "author_association", + "active_lock_reason", + "body" + ] + }, + "webhooks_comment": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": "integer", + "nullable": true + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { "type": "integer" }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "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", + "format": "int64" + }, "login": { "type": "string" }, @@ -116555,220 +128021,9 @@ "url": { "type": "string", "format": "uri" - } - }, - "required": [ - "login", - "id" - ] - } - }, - "required": [ - "repository_url", - "category", - "answer_html_url", - "answer_chosen_at", - "answer_chosen_by", - "html_url", - "id", - "node_id", - "number", - "title", - "user", - "state", - "state_reason", - "locked", - "comments", - "created_at", - "updated_at", - "author_association", - "active_lock_reason", - "body" - ] - }, - "webhooks_comment": { - "type": "object", - "properties": { - "author_association": { - "title": "AuthorAssociation", - "description": "How the author is associated with the repository.", - "type": "string", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "body": { - "type": "string" - }, - "child_comment_count": { - "type": "integer" - }, - "created_at": { - "type": "string" - }, - "discussion_id": { - "type": "integer" - }, - "html_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "parent_id": { - "type": "integer", - "nullable": true - }, - "reactions": { - "title": "Reactions", - "type": "object", - "properties": { - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "rocket": { - "type": "integer" - }, - "total_count": { - "type": "integer" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - }, - "repository_url": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "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": { + "user_view_type": { "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": [ @@ -116912,7 +128167,7 @@ }, "webhooks_issue_comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -117055,7 +128310,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -117101,6 +128357,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -117144,7 +128403,7 @@ }, "webhooks_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -117244,6 +128503,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -117339,6 +128601,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -117553,6 +128818,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -117813,6 +129081,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -118173,6 +129444,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -118242,7 +129533,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -118288,6 +129580,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -118423,6 +129718,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -118502,7 +129800,7 @@ }, "webhooks_issue_2": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -118601,6 +129899,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -118695,6 +129996,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -118908,6 +130212,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -119166,6 +130473,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -119525,6 +130835,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -119594,7 +130924,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -119639,6 +130970,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -119757,6 +131091,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -119836,6 +131173,14 @@ "secret" ] }, + "notification_setting": { + "description": "Whether team members will receive notifications when their team is @mentioned", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, "repositories_url": { "type": "string", "format": "uri" @@ -119856,6 +131201,7 @@ "slug", "description", "privacy", + "notification_setting", "url", "html_url", "members_url", @@ -119875,6 +131221,13 @@ "secret" ] }, + "notification_setting": { + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, "repositories_url": { "type": "string", "format": "uri" @@ -119901,7 +131254,8 @@ "id": { "description": "Unique identifier of the repository", "example": 42, - "type": "integer" + "type": "integer", + "format": "int64" }, "node_id": { "type": "string", @@ -120204,6 +131558,11 @@ "type": "string" } }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "has_issues": { "description": "Whether issues are enabled.", "default": true, @@ -120669,7 +132028,7 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "default": false, "deprecated": true }, @@ -120925,6 +132284,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121061,7 +132423,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -121106,6 +132469,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121122,6 +132488,183 @@ "user" ] }, + "personal-access-token-request": { + "title": "Personal Access Token Request", + "description": "Details of a Personal Access Token Request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "permissions_added": { + "type": "object", + "description": "New requested permissions, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "permissions_upgraded": { + "type": "object", + "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "permissions_result": { + "type": "object", + "description": "Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "repository_selection": { + "type": "string", + "description": "Type of repository selection requested.", + "enum": [ + "none", + "all", + "subset" + ] + }, + "repository_count": { + "description": "The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`.", + "type": "integer", + "nullable": true + }, + "repositories": { + "type": "array", + "description": "An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`.", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + }, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": "string", + "description": "Date and time when the associated fine-grained personal access token expires.", + "nullable": true + }, + "token_last_used_at": { + "type": "string", + "description": "Date and time when the associated fine-grained personal access token was last used for authentication.", + "nullable": true + } + }, + "required": [ + "id", + "owner", + "permissions_added", + "permissions_upgraded", + "permissions_result", + "repository_selection", + "repository_count", + "repositories", + "created_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + }, "webhooks_project_card": { "title": "Project Card", "type": "object", @@ -121234,6 +132777,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121381,6 +132927,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -121649,6 +133198,56 @@ "archived_at" ] }, + "projects-v2-single-select-option": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "name" + ] + }, + "projects-v2-iteration-setting": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "title": { + "type": "string" + }, + "duration": { + "type": "number", + "nullable": true + }, + "start_date": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "title" + ] + }, "webhooks_number": { "description": "The pull request number.", "type": "integer" @@ -121710,7 +133309,7 @@ ] }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.**", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**", "type": "boolean", "default": false } @@ -121941,6 +133540,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122160,6 +133762,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122388,7 +133993,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -122590,6 +134196,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -122873,7 +134482,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -122918,6 +134528,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123179,7 +134792,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -123381,6 +134995,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123664,7 +135281,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -123709,6 +135327,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -123893,6 +135514,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124004,6 +135628,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124531,7 +136158,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -124577,6 +136205,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -124626,7 +136257,7 @@ }, "webhooks_review_comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -124897,7 +136528,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -124942,6 +136574,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125104,7 +136739,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -125149,6 +136785,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125177,7 +136816,7 @@ }, "webhooks_release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases/#get-a-release) object.", "type": "object", "properties": { "assets": { @@ -125431,6 +137070,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -125577,7 +137219,7 @@ }, "webhooks_release_1": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -125856,6 +137498,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -126199,6 +137844,10 @@ "type": "string", "description": "The type of secret that secret scanning detected." }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", @@ -126244,6 +137893,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -126442,6 +138094,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -126536,6 +138191,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126628,6 +138286,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -126823,6 +138484,14 @@ "secret" ] }, + "notification_setting": { + "description": "Whether team members will receive notifications when their team is @mentioned", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, "repositories_url": { "type": "string", "format": "uri" @@ -126843,6 +138512,7 @@ "slug", "description", "privacy", + "notification_setting", "url", "html_url", "members_url", @@ -126862,6 +138532,14 @@ "secret" ] }, + "notification_setting": { + "description": "Whether team members will receive notifications when their team is @mentioned", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, "repositories_url": { "type": "string", "format": "uri" @@ -126880,6 +138558,70 @@ "id" ] }, + "webhook-branch-protection-configuration-disabled": { + "title": "branch protection configuration disabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "disabled" + ] + }, + "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" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-branch-protection-configuration-enabled": { + "title": "branch protection configuration enabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "enabled" + ] + }, + "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" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, "webhook-branch-protection-rule-created": { "title": "branch protection rule created event", "type": "object", @@ -126906,7 +138648,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -126942,7 +138684,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -127032,6 +138774,62 @@ "from" ] }, + "lock_branch_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "lock_allows_fork_sync": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "pull_request_reviews_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "require_last_push_approval": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, "required_status_checks": { "type": "object", "properties": { @@ -127080,7 +138878,7 @@ "$ref": "#/components/schemas/webhooks_rule" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -127090,6 +138888,189 @@ "sender" ] }, + "webhook-exemption-request-cancelled": { + "title": "Exemption request cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-completed": { + "title": "Exemption request completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-created": { + "title": "Exemption request created event", + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "sender" + ] + }, + "webhook-exemption-request-response-dismissed": { + "title": "Exemption response dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_dismissed" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, + "webhook-exemption-request-response-submitted": { + "title": "Exemption response submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "response_submitted" + ] + }, + "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" + }, + "exemption_request": { + "$ref": "#/components/schemas/exemption-request" + }, + "exemption_response": { + "$ref": "#/components/schemas/exemption-response" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "exemption_request", + "exemption_response", + "sender" + ] + }, "webhook-cache-sync": { "type": "object", "properties": { @@ -127118,7 +139099,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -127151,7 +139132,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -127197,7 +139178,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -127253,7 +139234,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -127300,7 +139281,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -127334,7 +139315,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -127430,6 +139411,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -127522,6 +139508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128093,7 +140082,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -128114,7 +140103,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -128211,6 +140200,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "Client ID of the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -128303,6 +140297,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -128872,7 +140869,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -128893,7 +140890,7 @@ ] }, "check_suite": { - "description": "The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite).", + "description": "The [check_suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { @@ -128985,6 +140982,11 @@ "type": "integer", "nullable": true }, + "client_id": { + "description": "The Client ID for the GitHub app", + "type": "string", + "nullable": true + }, "name": { "description": "The name of the GitHub app", "type": "string" @@ -129077,6 +141079,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129645,7 +141650,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -129765,6 +141770,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -129961,7 +141969,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -130082,6 +142090,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130239,261 +142250,262 @@ "state": { "description": "State of a code scanning alert.", "type": "string", - "enum": [ - "dismissed", - "fixed" - ] - }, - "tool": { - "type": "object", - "properties": { - "guid": { - "type": "string", - "nullable": true - }, - "name": { - "description": "The name of the tool used to generate the code scanning analysis alert.", - "type": "string" - }, - "version": { - "description": "The version of the tool used to detect the alert.", - "type": "string", - "nullable": true - } - }, - "required": [ - "name", - "version" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "number", - "created_at", - "url", - "html_url", - "state", - "dismissed_by", - "dismissed_at", - "dismissed_reason", - "rule", - "tool" - ] - }, - "commit_oid": { - "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" - }, - "enterprise": { - "$ref": "#/components/schemas/enterprise-webhooks" - }, - "installation": { - "$ref": "#/components/schemas/simple-installation" - }, - "organization": { - "$ref": "#/components/schemas/organization-simple-webhooks" - }, - "ref": { - "$ref": "#/components/schemas/webhooks_code_scanning_ref" - }, - "repository": { - "$ref": "#/components/schemas/repository-webhooks" - }, - "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" - } - }, - "required": [ - "action", - "alert", - "ref", - "commit_oid", - "repository", - "sender" - ] - }, - "webhook-code-scanning-alert-created": { - "title": "code_scanning_alert created event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "created" - ] - }, - "alert": { - "description": "The code scanning alert involved in the event.", - "type": "object", - "properties": { - "created_at": { - "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", - "type": "string", - "nullable": true, - "format": "date-time" - }, - "dismissed_at": { - "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", - "nullable": true - }, - "dismissed_by": { - "nullable": true - }, - "dismissed_comment": { - "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - }, - "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "nullable": true - }, - "fixed_at": { - "nullable": true - }, - "html_url": { - "description": "The GitHub URL of the alert resource.", - "type": "string", - "format": "uri" - }, - "instances_url": { - "type": "string" - }, - "most_recent_instance": { - "title": "Alert Instance", - "type": "object", + "enum": [ + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-created": { + "title": "code_scanning_alert created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "dismissed_by": { + "nullable": true + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true + }, + "fixed_at": { + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", "nullable": true, - "properties": { - "analysis_key": { - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", - "type": "string" - }, - "category": { - "description": "Identifies the configuration under which the analysis was executed.", - "type": "string" - }, - "classifications": { - "type": "array", - "items": { - "type": "string" - } - }, - "commit_sha": { - "type": "string" - }, - "environment": { - "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", - "type": "string" - }, - "location": { - "type": "object", - "properties": { - "end_column": { - "type": "integer" - }, - "end_line": { - "type": "integer" - }, - "path": { - "type": "string" - }, - "start_column": { - "type": "integer" - }, - "start_line": { - "type": "integer" - } - } - }, - "message": { - "type": "object", - "properties": { - "text": { - "type": "string" - } - } - }, - "ref": { - "description": "The full Git reference, formatted as `refs/heads/`.", - "type": "string" - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - }, - "required": [ - "ref", - "analysis_key", - "environment", - "state" - ] - }, - "number": { - "description": "The code scanning alert number.", - "type": "integer" - }, - "rule": { - "type": "object", - "properties": { - "description": { - "description": "A short description of the rule used to detect the alert.", - "type": "string" - }, - "full_description": { - "type": "string" - }, - "help": { - "type": "string", - "nullable": true - }, - "help_uri": { - "description": "A link to the documentation for the rule used to detect the alert.", - "type": "string", - "nullable": true - }, - "id": { - "description": "A unique identifier for the rule used to detect the alert.", - "type": "string" - }, - "name": { - "type": "string" - }, - "severity": { - "description": "The severity of the alert.", - "type": "string", - "nullable": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - }, - "tags": { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - }, - "required": [ - "id", - "severity", - "description" - ] - }, - "state": { - "description": "State of a code scanning alert.", - "type": "string", "enum": [ "open", "dismissed" @@ -130563,7 +142575,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -130685,6 +142697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -130909,7 +142924,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131163,7 +143178,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131382,7 +143397,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131406,7 +143421,7 @@ ] }, "comment": { - "description": "The [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment) resource.", + "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource.", "type": "object", "properties": { "author_association": { @@ -131558,7 +143573,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -131603,6 +143619,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -131640,7 +143659,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131690,7 +143709,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131734,7 +143753,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131745,6 +143764,78 @@ "sender" ] }, + "webhook-dependabot-alert-auto-dismissed": { + "title": "Dependabot alert auto-dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_dismissed" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-auto-reopened": { + "title": "Dependabot alert auto-reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_reopened" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, "webhook-dependabot-alert-created": { "title": "Dependabot alert created event", "type": "object", @@ -131771,7 +143862,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131807,7 +143898,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131843,7 +143934,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131879,7 +143970,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131915,7 +144006,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131951,7 +144042,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -131987,7 +144078,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -132009,7 +144100,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -132100,6 +144191,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132313,6 +144407,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -132655,7 +144752,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -132750,6 +144847,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133459,6 +145559,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133516,6 +145619,52 @@ "sender" ] }, + "webhook-deployment-protection-rule-requested": { + "title": "deployment protection rule requested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "environment": { + "description": "The name of the environment that has the deployment protection rule.", + "type": "string" + }, + "event": { + "description": "The event that triggered the deployment protection rule.", + "type": "string" + }, + "deployment_callback_url": { + "description": "The URL to review the deployment protection rule.", + "type": "string", + "format": "uri" + }, + "deployment": { + "$ref": "#/components/schemas/deployment" + }, + "pull_requests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request" + } + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + } + }, "webhook-deployment-review-approved": { "type": "object", "properties": { @@ -133547,7 +145696,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -133678,6 +145827,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -133893,6 +146045,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -134244,6 +146399,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -134391,6 +146549,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134480,7 +146641,7 @@ "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -134612,6 +146773,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -134824,6 +146988,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -135175,6 +147342,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -135321,6 +147491,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135499,6 +147672,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135516,7 +147692,7 @@ } }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" @@ -135651,6 +147827,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -135863,6 +148042,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -136214,6 +148396,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -136361,6 +148546,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136524,7 +148712,7 @@ }, "deployment": { "title": "Deployment", - "description": "The [deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments).", + "description": "The [deployment](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { @@ -136615,6 +148803,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -136829,6 +149020,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137159,7 +149353,7 @@ ] }, "deployment_status": { - "description": "The [deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#list-deployment-statuses).", + "description": "The [deployment status](https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#list-deployment-statuses).", "type": "object", "properties": { "created_at": { @@ -137250,6 +149444,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137462,6 +149659,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -137790,7 +149990,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -137885,6 +150085,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138595,6 +150798,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -138681,7 +150887,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138781,7 +150987,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138818,7 +151024,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138857,7 +151063,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138897,7 +151103,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138956,7 +151162,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -138994,7 +151200,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139030,7 +151236,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139093,7 +151299,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139132,7 +151338,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139169,7 +151375,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139205,7 +151411,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139241,7 +151447,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139292,7 +151498,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139326,7 +151532,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139365,7 +151571,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139402,7 +151608,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139438,7 +151644,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139458,7 +151664,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139475,7 +151681,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -139491,7 +151697,7 @@ "$ref": "#/components/schemas/enterprise-webhooks" }, "forkee": { - "description": "The created [`repository`](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) resource.", + "description": "The created [`repository`](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository) resource.", "allOf": [ { "title": "Repository", @@ -139585,11 +151791,6 @@ } ] }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -139688,7 +151889,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -139873,6 +152075,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140394,8 +152599,7 @@ } } } - ], - "properties": {} + ] }, "installation": { "$ref": "#/components/schemas/simple-installation" @@ -140407,7 +152611,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140427,7 +152631,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140498,7 +152702,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140536,7 +152740,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140574,7 +152778,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140612,7 +152816,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140680,7 +152884,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140759,7 +152963,7 @@ "$ref": "#/components/schemas/webhooks_user" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140801,7 +153005,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -140816,6 +153020,10 @@ "account": { "type": "object", "properties": { + "archived_at": { + "type": "string", + "nullable": true + }, "avatar_url": { "type": "string" }, @@ -140920,6 +153128,9 @@ }, "website_url": { "nullable": true + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -140975,7 +153186,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "target_type": { "type": "string" @@ -141018,7 +153229,7 @@ "nullable": true }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -141039,7 +153250,7 @@ }, "comment": { "title": "issue comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment) itself.", "type": "object", "properties": { "author_association": { @@ -141182,7 +153393,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -141227,6 +153439,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141257,11 +153472,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -141361,6 +153576,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141456,6 +153674,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141670,6 +153891,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -141930,6 +154154,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142291,6 +154518,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -142360,7 +154607,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -142406,6 +154654,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142531,6 +154782,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -142721,7 +154975,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -142772,7 +155027,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -142803,11 +155058,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -142907,6 +155162,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143002,6 +155260,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143216,6 +155477,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143474,6 +155738,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -143833,6 +156100,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -143902,7 +156189,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -143948,6 +156236,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144073,6 +156364,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144263,7 +156557,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -144294,6 +156589,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -144314,7 +156612,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -144348,11 +156646,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -144452,6 +156750,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144547,6 +156848,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -144761,6 +157065,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145021,6 +157328,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145381,6 +157691,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -145450,7 +157780,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -145496,6 +157827,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145621,6 +157955,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -145811,7 +158148,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -145862,7 +158200,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145904,7 +158242,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -145932,11 +158270,11 @@ "$ref": "#/components/schemas/simple-installation" }, "issue": { - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "allOf": [ { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -146036,6 +158374,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146131,6 +158472,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146345,6 +158689,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146606,6 +158953,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -146966,6 +159316,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -147035,7 +159405,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -147081,6 +159452,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147269,7 +159643,8 @@ "type": "string" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -147300,6 +159675,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } } @@ -147318,7 +159696,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -147346,7 +159724,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -147445,6 +159823,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -147752,6 +160133,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148011,6 +160395,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148370,6 +160757,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -148439,7 +160846,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -148484,6 +160892,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -148523,7 +160934,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -148551,7 +160962,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -149006,6 +161417,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -149257,6 +161671,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -149602,6 +162019,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -149675,7 +162112,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -149721,6 +162159,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -149736,7 +162177,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -149794,7 +162235,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -149894,6 +162335,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150203,6 +162647,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150464,6 +162911,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150824,6 +163274,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -150893,7 +163363,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -150939,6 +163410,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -150981,7 +163455,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -151010,7 +163484,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -151110,6 +163584,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151419,6 +163896,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -151679,6 +164159,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152039,6 +164522,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -152108,7 +164611,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -152154,6 +164658,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -152196,7 +164703,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -152224,7 +164731,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -152351,6 +164858,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -152445,6 +164955,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -152680,6 +165193,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -152933,6 +165449,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -153277,6 +165796,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -153350,7 +165889,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -153395,6 +165935,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -153407,7 +165950,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -153435,7 +165978,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -153888,6 +166431,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -154140,6 +166686,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -154485,6 +167034,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -154558,7 +167127,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -154603,6 +167173,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -154618,7 +167191,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -154644,7 +167217,7 @@ "properties": { "old_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "nullable": true, "properties": { @@ -154744,6 +167317,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -154838,6 +167414,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155051,6 +167630,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155309,6 +167891,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155668,6 +168253,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -155737,7 +168342,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -155782,6 +168388,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -155906,6 +168515,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -156008,7 +168622,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -156193,6 +168808,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156424,7 +169042,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -156523,6 +169141,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156617,6 +169238,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -156831,6 +169455,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157092,6 +169719,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157452,6 +170082,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -157521,7 +170171,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -157566,6 +170217,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -157605,7 +170259,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -157641,7 +170295,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -157669,7 +170323,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -158124,6 +170778,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -158377,6 +171034,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -158723,6 +171383,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -158796,7 +171476,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -158842,6 +171523,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -158854,7 +171538,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -158879,7 +171563,7 @@ "properties": { "new_issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { @@ -158978,6 +171662,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159072,6 +171759,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159285,6 +171975,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159543,6 +172236,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -159902,6 +172598,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -159971,7 +172687,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -160016,6 +172733,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160140,6 +172860,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -160243,7 +172968,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -160428,6 +173154,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -160668,7 +173397,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160709,7 +173438,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160748,7 +173477,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -160776,7 +173505,7 @@ }, "issue": { "title": "Issue", - "description": "The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself.", + "description": "The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", @@ -160903,6 +173632,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -160997,6 +173729,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -161232,6 +173967,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -161483,6 +174221,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -161827,6 +174568,26 @@ "type": "string", "format": "uri" }, + "sub_issues_summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", @@ -161900,7 +174661,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -161945,6 +174707,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } } @@ -161957,7 +174722,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -161993,7 +174758,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162029,7 +174794,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162064,7 +174829,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162142,7 +174907,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162212,7 +174977,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162279,7 +175044,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162316,7 +175081,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162443,6 +175208,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162581,6 +175349,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -162750,7 +175521,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162785,7 +175556,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162821,7 +175592,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162857,7 +175628,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162935,7 +175706,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -162972,7 +175743,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163008,7 +175779,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163043,7 +175814,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163182,6 +175953,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163227,7 +176001,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -163266,7 +176040,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163315,7 +176089,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -163506,6 +176280,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -163605,6 +176382,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164041,6 +176821,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164190,7 +176973,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164330,6 +177113,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164428,6 +177214,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164638,6 +177427,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164793,7 +177585,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164808,7 +177600,7 @@ "type": "object", "properties": { "build": { - "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.9/rest/pages/pages#list-github-pages-builds) itself.", + "description": "The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.15/rest/pages/pages#list-github-pages-builds) itself.", "type": "object", "properties": { "commit": { @@ -164918,6 +177710,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -164963,7 +177758,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -164973,6 +177768,141 @@ "sender" ] }, + "webhook-personal-access-token-request-approved": { + "title": "personal_access_token_request approved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "approved" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender", + "installation" + ] + }, + "webhook-personal-access-token-request-cancelled": { + "title": "personal_access_token_request cancelled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender", + "installation" + ] + }, + "webhook-personal-access-token-request-created": { + "title": "personal_access_token_request created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender" + ] + }, + "webhook-personal-access-token-request-denied": { + "title": "personal_access_token_request denied event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "denied" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender", + "installation" + ] + }, "webhook-ping": { "type": "object", "properties": { @@ -165077,7 +178007,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "zen": { "description": "Random string of GitHub zen.", @@ -165143,7 +178073,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165179,7 +178109,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165321,6 +178251,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165370,7 +178303,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165425,7 +178358,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165588,6 +178521,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -165742,7 +178678,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165777,7 +178713,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165812,7 +178748,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165846,7 +178782,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165896,7 +178832,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165931,7 +178867,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -165966,7 +178902,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166001,7 +178937,7 @@ "$ref": "#/components/schemas/nullable-repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166065,7 +179001,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166099,7 +179035,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166128,7 +179064,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166158,7 +179094,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166188,7 +179124,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166271,7 +179207,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166305,7 +179241,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166353,7 +179289,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166384,7 +179320,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166414,7 +179350,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166435,6 +179371,7 @@ ] }, "changes": { + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.", "oneOf": [ { "type": "object", @@ -166447,6 +179384,46 @@ }, "field_type": { "type": "string" + }, + "field_name": { + "type": "string" + }, + "project_number": { + "type": "integer" + }, + "from": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] + }, + "to": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] } } } @@ -166488,7 +179465,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166536,7 +179513,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166570,7 +179547,7 @@ "$ref": "#/components/schemas/projects-v2-item" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166601,7 +179578,7 @@ "$ref": "#/components/schemas/projects-v2" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166628,7 +179605,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -166884,6 +179861,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -166979,6 +179959,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167103,6 +180086,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167331,7 +180317,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -167533,6 +180520,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -167672,7 +180662,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -167816,7 +180806,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -167861,6 +180852,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168124,7 +181118,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -168326,6 +181321,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168465,7 +181463,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -168609,7 +181607,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -168654,6 +181653,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168837,6 +181839,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -168948,6 +181953,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169130,6 +182138,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169485,7 +182496,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -169531,6 +182543,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -169582,7 +182597,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -169838,6 +182853,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170056,6 +183074,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170284,7 +183305,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -170486,6 +183508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -170625,7 +183650,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -170769,7 +183794,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -170814,6 +183840,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171075,7 +184104,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -171277,6 +184307,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171416,7 +184449,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -171560,7 +184593,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -171605,6 +184639,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171788,6 +184825,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -171898,6 +184938,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172080,6 +185123,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172435,7 +185481,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -172481,6 +185528,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -172535,7 +185585,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -172791,6 +185841,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173009,6 +186062,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173237,7 +186293,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -173439,6 +186496,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -173578,7 +186638,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -173722,7 +186782,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -173767,6 +186828,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174230,6 +187294,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174369,7 +187436,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -174513,7 +187580,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -174558,6 +187626,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174741,6 +187812,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -174852,6 +187926,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175034,6 +188111,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175389,7 +188469,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -175435,6 +188516,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -175489,7 +188573,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175529,7 +188613,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175569,7 +188653,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175609,7 +188693,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175709,7 +188793,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -175968,6 +189052,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176187,6 +189274,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176415,7 +189505,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -176617,6 +189708,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -176756,7 +189850,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -176900,7 +189994,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -176945,6 +190040,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177208,7 +190306,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -177410,6 +190509,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177549,7 +190651,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -177693,7 +190795,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -177738,6 +190841,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -177922,6 +191028,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178033,6 +191142,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178215,6 +191327,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178570,7 +191685,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -178616,6 +191732,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -178667,7 +191786,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -178922,6 +192041,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179141,6 +192263,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179369,7 +192494,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -179571,6 +192697,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -179710,7 +192839,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -179854,7 +192983,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -179899,6 +193029,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180162,7 +193295,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -180364,6 +193498,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180503,7 +193640,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -180647,7 +193784,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -180692,6 +193830,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180876,6 +194017,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -180986,6 +194130,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181168,6 +194315,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181523,7 +194673,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -181569,6 +194720,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -181620,7 +194774,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181660,7 +194814,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181699,7 +194853,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181739,7 +194893,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181779,7 +194933,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -181802,7 +194956,7 @@ }, "comment": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -182074,7 +195228,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -182119,6 +195274,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182383,6 +195541,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182602,6 +195763,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -182830,7 +195994,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -183032,6 +196197,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183171,7 +196339,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -183315,7 +196483,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -183360,6 +196529,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183607,7 +196779,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -183809,6 +196982,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -183948,7 +197124,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -184091,7 +197267,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184136,6 +197313,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184322,6 +197502,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184499,6 +197682,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184848,7 +198034,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -184894,6 +198081,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -184943,7 +198133,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -185194,6 +198384,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185412,6 +198605,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185640,7 +198836,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -185842,6 +199039,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -185981,7 +199181,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -186125,7 +199325,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -186170,6 +199371,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186417,7 +199621,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -186619,6 +199824,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -186758,7 +199966,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -186902,7 +200110,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -186947,6 +200156,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187132,6 +200344,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187308,6 +200523,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187648,7 +200866,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -187694,6 +200913,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -187743,7 +200965,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -187997,6 +201219,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188091,6 +201316,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188215,6 +201443,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188443,7 +201674,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -188645,6 +201877,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -188784,7 +202019,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -188928,7 +202163,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -188973,6 +202209,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189220,7 +202459,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -189422,6 +202662,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189561,7 +202804,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -189705,7 +202948,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -189750,6 +202994,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -189936,6 +203183,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190112,6 +203362,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -190452,7 +203705,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -190495,6 +203749,9 @@ "Mannequin" ] }, + "user_view_type": { + "type": "string" + }, "url": { "type": "string", "format": "uri" @@ -190547,7 +203804,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -190798,6 +204055,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191017,6 +204277,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191245,7 +204508,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -191447,6 +204711,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -191586,7 +204853,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -191730,7 +204997,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -191775,6 +205043,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192022,7 +205293,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -192224,6 +205496,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192363,7 +205638,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -192507,7 +205782,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -192552,6 +205828,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192737,6 +206016,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -192914,6 +206196,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193263,7 +206548,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193309,6 +206595,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193489,7 +206778,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -193535,6 +206825,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -193558,7 +206851,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -193825,6 +207118,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194044,6 +207340,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194267,7 +207566,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -194452,6 +207752,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194708,7 +208011,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -194753,6 +208057,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -194995,7 +208302,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -195180,6 +208488,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195436,7 +208747,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -195481,6 +208793,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195667,6 +208982,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -195844,6 +209162,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196193,7 +209514,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -196239,6 +209561,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196293,7 +209618,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -196552,6 +209877,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196646,6 +209974,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196770,6 +210101,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -196998,7 +210332,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -197200,6 +210535,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197339,7 +210677,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -197483,7 +210821,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -197528,6 +210867,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -197789,7 +211131,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -197991,6 +211334,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198130,7 +211476,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -198274,7 +211620,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -198319,6 +211666,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198502,6 +211852,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198612,6 +211965,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -198793,6 +212149,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199157,7 +212516,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -199202,6 +212562,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199337,6 +212700,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199345,7 +212711,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -199601,6 +212967,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199695,6 +213064,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -199819,6 +213191,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200047,7 +213422,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -200249,6 +213625,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200388,7 +213767,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -200532,7 +213911,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -200577,6 +213957,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -200838,7 +214221,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -201040,6 +214424,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201179,7 +214566,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -201323,7 +214710,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -201368,6 +214756,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201551,6 +214942,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201661,6 +215055,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -201842,6 +215239,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202206,7 +215606,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -202251,6 +215652,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202440,7 +215844,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -202702,6 +216106,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202797,6 +216204,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -202921,6 +216331,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203149,7 +216562,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -203351,6 +216765,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203490,7 +216907,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -203634,7 +217051,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -203679,6 +217097,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -203940,7 +217361,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -204142,6 +217564,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204281,7 +217706,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -204425,7 +217850,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -204470,6 +217896,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204653,6 +218082,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204764,6 +218196,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -204945,6 +218380,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205300,7 +218738,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -205346,6 +218785,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205482,6 +218924,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205490,7 +218935,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -205747,6 +219192,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205842,6 +219290,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -205966,6 +219417,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206194,7 +219648,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -206396,6 +219851,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206535,7 +219993,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -206679,7 +220137,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -206724,6 +220183,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -206985,7 +220447,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -207187,6 +220650,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207326,7 +220792,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -207470,7 +220936,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -207515,6 +220982,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207698,6 +221168,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207809,6 +221282,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -207990,6 +221466,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208336,7 +221815,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -208382,6 +221862,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -208562,7 +222045,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -208815,6 +222298,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209034,6 +222520,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209262,7 +222751,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -209464,6 +222954,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -209603,7 +223096,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -209747,7 +223240,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -209792,6 +223286,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210040,7 +223537,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -210242,6 +223740,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210381,7 +223882,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -210525,7 +224026,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -210570,6 +224072,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210756,6 +224261,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -210933,6 +224441,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211282,7 +224793,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -211328,6 +224840,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211382,7 +224897,7 @@ "$ref": "#/components/schemas/webhooks_review" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -211631,6 +225146,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -211849,6 +225367,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212077,7 +225598,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -212262,6 +225784,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212523,7 +226048,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -212568,6 +226094,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -212816,7 +226345,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -213001,6 +226531,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213262,7 +226795,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -213307,6 +226841,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213492,6 +227029,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -213669,6 +227209,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214018,7 +227561,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214064,6 +227608,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214115,7 +227662,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -214124,7 +227671,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -214396,7 +227943,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -214442,6 +227990,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214734,6 +228285,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -214951,6 +228505,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215179,7 +228736,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -215364,6 +228922,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215625,7 +229186,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -215670,6 +229232,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -215916,7 +229481,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -216101,6 +229667,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216362,7 +229931,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -216407,6 +229977,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216592,6 +230165,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -216768,6 +230344,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217108,7 +230687,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217153,6 +230733,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217204,7 +230787,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "thread": { "type": "object", @@ -217213,7 +230796,7 @@ "type": "array", "items": { "title": "Pull Request Review Comment", - "description": "The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "description": "The [comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", "type": "object", "properties": { "_links": { @@ -217484,7 +231067,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -217529,6 +231113,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -217834,6 +231421,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218053,6 +231643,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218281,7 +231874,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -218483,6 +232077,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -218622,7 +232219,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -218766,7 +232363,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -218811,6 +232409,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219072,7 +232673,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -219274,6 +232876,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219413,7 +233018,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -219557,7 +233162,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -219602,6 +233208,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219785,6 +233394,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -219896,6 +233508,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220078,6 +233693,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220433,7 +234051,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -220479,6 +234098,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -220530,7 +234152,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -220791,6 +234413,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221010,6 +234635,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221239,7 +234867,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -221441,6 +235070,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -221580,7 +235212,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -221724,7 +235356,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -221769,6 +235402,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222032,7 +235668,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -222234,6 +235871,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222373,7 +236013,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -222517,7 +236157,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -222562,6 +236203,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222746,6 +236390,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -222857,6 +236504,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223039,6 +236689,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223394,7 +237047,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -223440,6 +237094,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223491,7 +237148,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -223749,6 +237406,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -223968,6 +237628,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224196,7 +237859,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -224398,6 +238062,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224537,7 +238204,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -224681,7 +238348,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -224726,6 +238394,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -224989,7 +238660,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -225191,6 +238863,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225330,7 +239005,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -225474,7 +239149,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -225519,6 +239195,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225702,6 +239381,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225813,6 +239495,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -225995,6 +239680,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226350,7 +240038,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -226396,6 +240085,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226447,7 +240139,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -226702,6 +240394,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -226919,6 +240614,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227147,7 +240845,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -227349,6 +241048,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227488,7 +241190,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -227632,7 +241334,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -227677,6 +241380,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -227939,7 +241645,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -228141,6 +241848,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228280,7 +241990,7 @@ "format": "uri" }, "use_squash_pr_title_as_default": { - "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", "type": "boolean", "default": false }, @@ -228424,7 +242134,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -228469,6 +242180,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228652,6 +242366,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228762,6 +242479,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -228943,6 +242663,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229289,7 +243012,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -229334,6 +243058,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -229385,7 +243112,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -229412,7 +243139,7 @@ "type": "string" }, "commits": { - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.9/rest/commits) to fetch additional commits.", + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.15/rest/commits) to fetch additional commits.", "type": "array", "items": { "title": "Commit", @@ -229793,6 +243520,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -229896,7 +243628,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -230081,6 +243814,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230300,7 +244036,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -230418,6 +244154,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230504,6 +244243,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -230963,6 +244705,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } } }, @@ -231082,7 +244827,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -231189,6 +244934,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231274,6 +245022,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231457,6 +245208,9 @@ }, "url": { "type": "string" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -231597,7 +245351,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -231632,7 +245386,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -231668,7 +245422,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -231745,7 +245499,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -231776,7 +245530,7 @@ }, "release": { "title": "Release", - "description": "The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object.", + "description": "The [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", @@ -232055,6 +245809,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -232182,7 +245939,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232217,7 +245974,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232252,7 +246009,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232287,7 +246044,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232318,7 +246075,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232347,7 +246104,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232377,7 +246134,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232409,7 +246166,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232441,7 +246198,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232480,7 +246237,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232567,7 +246324,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232600,7 +246357,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232632,7 +246389,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232691,7 +246448,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232701,6 +246458,260 @@ "sender" ] }, + "webhook-repository-ruleset-created": { + "title": "repository ruleset created event", + "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" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, + "webhook-repository-ruleset-deleted": { + "title": "repository ruleset deleted event", + "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" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, + "webhook-repository-ruleset-edited": { + "title": "repository ruleset edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "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" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "enforcement": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "conditions": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + }, + "deleted": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "condition": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "changes": { + "type": "object", + "properties": { + "condition_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "target": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "include": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "exclude": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "rules": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "deleted": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/repository-rule" + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, "webhook-repository-transferred": { "title": "repository transferred event", "type": "object", @@ -232829,7 +246840,8 @@ "format": "uri" }, "id": { - "type": "integer" + "type": "integer", + "format": "int64" }, "login": { "type": "string" @@ -232874,6 +246886,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -232906,7 +246921,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232939,7 +246954,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -232974,7 +246989,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233123,6 +247138,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -233180,7 +247198,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233216,7 +247234,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233416,7 +247434,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233452,7 +247470,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233487,7 +247505,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233536,7 +247554,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233571,7 +247589,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233580,14 +247598,14 @@ "repository" ] }, - "webhook-secret-scanning-alert-revoked": { - "title": "secret_scanning_alert revoked event", + "webhook-secret-scanning-alert-validated": { + "title": "secret_scanning_alert validated event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "revoked" + "validated" ] }, "alert": { @@ -233606,7 +247624,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233641,7 +247659,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233675,7 +247693,7 @@ "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233725,6 +247743,9 @@ "score" ] }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, "cwes": { "type": "array", "items": { @@ -233861,7 +247882,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233899,7 +247920,7 @@ "$ref": "#/components/schemas/full-repository" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -233930,7 +247951,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -233965,7 +247986,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -234017,7 +248038,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -234056,7 +248077,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -234097,7 +248118,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -234136,7 +248157,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" @@ -234172,7 +248193,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -234210,7 +248231,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "starred_at": { "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", @@ -234714,7 +248735,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "sha": { "description": "The Commit SHA.", @@ -234772,7 +248793,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -234895,6 +248916,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -234993,7 +249019,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -235178,6 +249205,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -235392,7 +249422,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -235515,6 +249545,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -235613,7 +249648,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -235798,6 +249834,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236012,7 +250051,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -236136,6 +250175,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -236234,7 +250278,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -236419,6 +250464,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -236633,7 +250681,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -236843,6 +250891,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -236941,7 +250994,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -237126,6 +251180,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237340,7 +251397,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -237465,6 +251522,11 @@ } ] }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, "default_branch": { "description": "The default branch of the repository.", "type": "string" @@ -237563,7 +251625,8 @@ }, "id": { "description": "Unique identifier of the repository", - "type": "integer" + "type": "integer", + "format": "int64" }, "is_template": { "type": "boolean" @@ -237748,6 +251811,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -237962,7 +252028,7 @@ ] }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" @@ -237997,7 +252063,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -238029,7 +252095,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "user": { "$ref": "#/components/schemas/webhooks_user" @@ -238062,7 +252128,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" } }, "required": [ @@ -238096,7 +252162,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "type": "string" @@ -238133,7 +252199,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -238179,7 +252245,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.9/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.15/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -238464,7 +252530,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "allOf": [ @@ -238507,7 +252573,7 @@ "type": "integer" }, "labels": { - "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.9/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/enterprise-server@3.15/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", "type": "array", "items": { "type": "string" @@ -238827,7 +252893,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -239035,7 +253101,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow_job": { "type": "object", @@ -239244,7 +253310,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -239377,6 +253443,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -239409,7 +253478,8 @@ "skipped", "stale", "success", - "timed_out" + "timed_out", + "startup_failure" ] }, "created_at": { @@ -239777,6 +253847,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -240255,6 +254328,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -240418,6 +254494,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } } }, @@ -240475,7 +254554,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -241701,7 +255780,7 @@ "$ref": "#/components/schemas/repository-webhooks" }, "sender": { - "$ref": "#/components/schemas/simple-user-webhooks" + "$ref": "#/components/schemas/simple-user" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" @@ -241795,6 +255874,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242149,6 +256231,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242626,6 +256711,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -242837,6 +256925,9 @@ "url": { "type": "string", "format": "uri" + }, + "user_view_type": { + "type": "string" } }, "required": [ @@ -243308,7 +257399,7 @@ "allow_downstream_configuration": true } }, - "authorization-items": { + "classic-personal-access-tokens": { "value": [ { "id": 2, @@ -243389,10 +257480,200 @@ "fingerprint": "jklmnop12345678" } }, + "global-advisory-items": { + "value": [ + { + "id": 1, + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "Heartbleed security advisory", + "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "epss": [ + { + "percentage": 0.00045, + "percentile": "0.16001e0" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + ] + }, + "global-advisory": { + "value": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + }, "integration": { "value": { "id": 1, "slug": "octoapp", + "client_id": "Iv1.ab1112223334445c", "node_id": "MDExOkludGVncmF0aW9uMQ==", "owner": { "login": "octocat", @@ -243500,7 +257781,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" }, { "id": 123456789, @@ -243513,7 +257795,8 @@ "event": "issues", "action": "opened", "installation_id": 123, - "repository_id": 456 + "repository_id": 456, + "throttled_at": null } ] }, @@ -243531,6 +257814,7 @@ "installation_id": 123, "repository_id": 456, "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", "request": { "headers": { "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", @@ -244003,6 +258287,42 @@ } } }, + "authorization-items": { + "value": [ + { + "id": 2, + "url": "https://enterprise.octocat.com/api/v3/authorizations/2", + "app": { + "name": "My personal access token", + "url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens", + "client_id": "00000000000000000000" + }, + "token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a", + "hashed_token": "23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45", + "token_last_eight": "Ae178B4a", + "note": "My personal access token", + "note_url": null, + "created_at": "2019-04-24T21:49:02Z", + "updated_at": "2019-04-24T21:49:02Z", + "scopes": [ + "admin:business", + "admin:gpg_key", + "admin:org", + "admin:org_hook", + "admin:pre_receive_hook", + "admin:public_key", + "admin:repo_hook", + "delete_repo", + "gist", + "notifications", + "repo", + "user", + "write:discussion" + ], + "fingerprint": null + } + ] + }, "authorization-response-if-returning-an-existing-token-2": { "value": { "id": 1, @@ -246075,6 +260395,25 @@ } } }, + "enterprise-security-products-overview": { + "value": { + "total_repos": 150, + "nonarchived_repos": 130, + "secret_scanning_enabled_repos": 150, + "secret_scanning_push_protection_enabled_repos": 120, + "code_scanning_enabled_repos": 140, + "code_scanning_pr_reviews_enabled_repos": 100, + "code_scanning_default_setup_enabled_repos": 50, + "code_scanning_default_setup_eligible_repos": 30, + "dependabot_alerts_enabled_repos": 130, + "dependabot_security_updates_enabled_repos": 120, + "dependabot_version_updates_enabled_repos": 121, + "advanced_security_enabled_repos": 150, + "active_committers": 30, + "purchased_committers": 90, + "maximum_committers": 80 + } + }, "actions-cache-usage-org-enterprise": { "value": { "total_active_caches_size_in_bytes": 3344284, @@ -246313,6 +260652,40 @@ } ] }, + "runner-jitconfig": { + "value": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + } + }, "authentication-token": { "value": { "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", @@ -246799,7 +261172,8 @@ "dependabot_alerts_enabled_for_new_repositories": true, "secret_scanning_enabled_for_new_repositories": true, "secret_scanning_push_protection_enabled_for_new_repositories": true, - "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md" + "secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md", + "secret_scanning_non_provider_patterns_enabled_for_new_repositories": true } }, "dependabot-alerts-for-organization": { @@ -246849,6 +261223,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -247049,6 +261433,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -247293,7 +261687,31 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active" }, { "number": 1, @@ -247378,7 +261796,12 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" } ] }, @@ -247386,6 +261809,8 @@ "value": { "total_advanced_security_committers": 2, "total_count": 2, + "maximum_advanced_security_committers": 4, + "purchased_advanced_security_committers": 4, "repositories": [ { "name": "octocat-org/Hello-World", @@ -247393,11 +261818,13 @@ "advanced_security_committers_breakdown": [ { "user_login": "octocat", - "last_pushed_date": "2021-11-03" + "last_pushed_date": "2021-11-03", + "last_pushed_email": "octocat@github.com" }, { "user_login": "octokitten", - "last_pushed_date": "2021-10-25" + "last_pushed_date": "2021-10-25", + "last_pushed_email": "octokitten@github.com" } ] }, @@ -247407,7 +261834,8 @@ "advanced_security_committers_breakdown": [ { "user_login": "octokitten", - "last_pushed_date": "2021-10-26" + "last_pushed_date": "2021-10-26", + "last_pushed_email": "octokitten@github.com" } ] } @@ -247594,7 +262022,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -247602,7 +262031,6 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { "login": "monalisa", @@ -248490,6 +262918,191 @@ "featured": true } }, + "ghes-get-ssh": { + "value": [ + { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ==", + "fingeprint": "bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45" + }, + { + "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw==", + "fingeprint": "e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4" + } + ] + }, + "ghes-set-ssh": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "SSH key added successfully", + "modified": true + } + ] + }, + "ghes-delete-ssh": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "SSH key removed successfully" + } + ] + }, + "ghes-checks-system-requirements": { + "value": { + "status": "OK", + "nodes": [ + { + "hostname": "ghe-local-app", + "status": "OK", + "roles_status": [ + { + "status": "OK", + "role": "ConsulServer" + }, + { + "status": "OK", + "role": "JobServer" + }, + { + "status": "OK", + "role": "WebServer" + } + ] + }, + { + "hostname": "ghe-local-app2", + "status": "OK", + "roles_status": [ + { + "status": "OK", + "role": "ConsulServer" + }, + { + "status": "OK", + "role": "GitServer" + } + ] + } + ] + } + }, + "ghes-cluster-status": { + "value": { + "status": "OK", + "nodes": [ + { + "hostname": "ghe-local-app", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "es", + "details": "Elasticsearch cluster is in sync (0 shards initializing, 0 shards unassigned)" + }, + { + "status": "OK", + "name": "git-replication", + "details": "Git replication is in sync" + }, + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + }, + { + "status": "OK", + "name": "memcache", + "details": "" + }, + { + "status": "OK", + "name": "metrics", + "details": "" + }, + { + "status": "OK", + "name": "mysql-replication", + "details": "Replication is running" + }, + { + "status": "OK", + "name": "mysql-failover", + "details": "" + }, + { + "status": "OK", + "name": "pages", + "details": "Pages replication is in sync" + }, + { + "status": "OK", + "name": "redis", + "details": "Redis is OK" + }, + { + "status": "OK", + "name": "storage", + "details": "Storage replication is in sync" + } + ] + }, + { + "hostname": "ghe-local-app2", + "status": "OK", + "services": [ + { + "status": "OK", + "name": "kafka-lite-admin-healthcheck", + "details": "" + }, + { + "status": "OK", + "name": "kafka-lite-broker-is-reachable", + "details": "" + } + ] + } + ] + } + }, + "ghes-license-info": { + "value": [ + { + "advancedSecurityEnabled": true, + "advancedSecuritySeats": 0, + "clusterSupport": false, + "company": "GitHub", + "croquetSupport": true, + "customTerms": true, + "evaluation": false, + "expireAt": "2025-01-02T07:59:59Z", + "insightsEnabled": true, + "insightsExpireAt": "2025-01-02T07:59:59.999Z", + "learningLabEvaluationExpires": "2023-01-02T07:59:59Z", + "learningLabSeats": 100, + "perpetual": false, + "referenceNumber": "32a145", + "seats": 0, + "sshAllowed": true, + "supportKey\"": "", + "unlimitedSeating": true + } + ] + }, + "ghes-license-check": { + "value": [ + { + "status": "valid" + } + ] + }, "ghes-config-nodes": { "value": { "topology": "Cluster", @@ -248516,6 +263129,185 @@ ] } }, + "ghes-get-settings": { + "value": { + "private_mode": false, + "public_pages": false, + "subdomain_isolation": true, + "signup_enabled": false, + "github_hostname": "ghe.local", + "identicons_host": "dotcom", + "http_proxy": null, + "auth_mode": "default", + "expire_sessions": false, + "admin_password": null, + "configuration_id": 1401777404, + "configuration_run_count": 4, + "avatar": { + "enabled": false, + "uri": "" + }, + "customer": { + "name": "GitHub", + "email": "stannis@themannis.biz", + "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9", + "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", + "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n" + }, + "license": { + "seats": 0, + "evaluation": false, + "perpetual": false, + "unlimited_seating": true, + "support_key": "ssh-rsa AAAAB3N....", + "ssh_allowed": true, + "cluster_support": false, + "expire_at": "2016-04-27T00:00:00-07:00" + }, + "github_ssl": { + "enabled": false, + "cert": null, + "key": null + }, + "ldap": { + "host": null, + "port": 0, + "base": [], + "uid": null, + "bind_dn": null, + "password": null, + "method": "Plain", + "search_strategy": "detect", + "user_groups": [], + "admin_group": null, + "virtual_attribute_enabled": false, + "recursive_group_search": false, + "posix_support": true, + "user_sync_emails": false, + "user_sync_keys": false, + "user_sync_interval": 4, + "team_sync_interval": 4, + "sync_enabled": false, + "reconciliation": { + "user": null, + "org": null + }, + "profile": { + "uid": "uid", + "name": null, + "mail": null, + "key": null + } + }, + "cas": { + "url": null + }, + "saml": { + "sso_url": null, + "certificate": null, + "certificate_path": null, + "issuer": null, + "idp_initiated_sso": false, + "disable_admin_demote": false + }, + "github_oauth": { + "client_id": "12313412", + "client_secret": "kj123131132", + "organization_name": "Homestar Runners", + "organization_team": "homestarrunners/characters" + }, + "smtp": { + "enabled": true, + "address": "smtp.example.com", + "authentication": "plain", + "port": "1234", + "domain": "blah", + "username": "foo", + "user_name": "mr_foo", + "enable_starttls_auto": true, + "password": "bar", + "discard-to-noreply-address": true, + "support_address": "enterprise@github.com", + "support_address_type": "email", + "noreply_address": "noreply@github.com" + }, + "ntp": { + "primary_server": "0.pool.ntp.org", + "secondary_server": "1.pool.ntp.org" + }, + "timezone": null, + "snmp": { + "enabled": false, + "community": "" + }, + "syslog": { + "enabled": false, + "server": null, + "protocol_name": "udp" + }, + "assets": null, + "pages": { + "enabled": true + }, + "collectd": { + "enabled": false, + "server": null, + "port": 0, + "encryption": null, + "username": null, + "password": null + }, + "mapping": { + "enabled": true, + "tileserver": null, + "basemap": "company.map-qsz2zrvs", + "token": null + }, + "load_balancer": null + } + }, + "ghes-get-maintenance": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "status": "scheduled", + "scheduled_time": "2006-01-02T15:04:05+00:00", + "connection_services": [ + { + "name": "git operations", + "number": 15 + }, + { + "name": "mysql queries", + "number": 6 + }, + { + "name": "resque jobs", + "number": 10 + }, + { + "name": "aqueduct jobs", + "number": 0 + } + ], + "can_unset_maintenance": true, + "ip_exception_list": [ + "1.1.1.1" + ], + "maintenance_mode_message": "Scheduled maintenance for upgrading." + } + ] + }, + "ghes-set-maintenance": { + "value": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "maintenance mode scheduled with exception list [1.1.1.1]" + } + ] + }, "ghes-replication-status": { "value": { "status": "OK", @@ -248593,9 +263385,6 @@ "packages": [ "192.0.2.1" ], - "dependabot": [ - "192.0.2.1" - ], "domains": { "website": [ "*.example.com" @@ -248610,7 +263399,7 @@ "*.example.com" ] }, - "installed_version": "3.9.0" + "installed_version": "3.15.0" } }, "public-repo-events-items": { @@ -249629,6 +264418,235 @@ "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" } }, + "code-security-configuration-list": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 17, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + }, + "code-security-configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "code-security-default-configurations": { + "value": [ + { + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + } + } + ] + }, + "code-security-configuration-updated": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "simple-repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + }, "organization-custom-repository-role-list-example": { "value": { "total_count": 2, @@ -250014,6 +265032,7 @@ "repositories_url": "https://api.github.com/installation/repositories", "html_url": "https://github.com/organizations/github/settings/installations/1", "app_id": 1, + "client_id": "Iv1.ab1112223334445c", "target_id": 1, "target_type": "Organization", "permissions": { @@ -250759,11 +265778,144 @@ }, "secret_scanning_push_protection": { "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" } } } ] }, + "organization-fine-grained-permission-example": { + "value": [ + { + "name": "read_organization_custom_org_role", + "description": "View organization roles" + }, + { + "name": "write_organization_custom_org_role", + "description": "Manage custom organization roles" + } + ] + }, + "organization-role-list": { + "value": { + "total_count": 2, + "roles": [ + { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + }, + { + "id": 8031, + "name": "Auditor", + "description": "Permissions to read the organization audit log", + "permissions": [ + "read_audit_logs" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + ] + } + }, + "organization-role": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + }, + "team-items": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "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", + "parent": null + } + ] + }, "package-org": { "value": { "id": 197, @@ -250844,6 +265996,93 @@ } } }, + "org-pat-grant-request-paginated": { + "value": [ + { + "id": 25381, + "reason": "I need to access the GitHub API", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + }, + "org-pat-grant-paginated": { + "value": [ + { + "id": 25381, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + }, "org-pre-receive-hook-items": { "value": [ { @@ -250949,6 +266188,97 @@ "updated_at": "2014-03-04T18:58:10Z" } }, + "custom-properties": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "custom-property": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "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" + } + ] + } + }, "full-repository": { "value": { "id": 1296269, @@ -251477,24 +266807,179 @@ } ] }, - "team-items": { + "org-ruleset-items": { "value": [ { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null + "id": 21, + "name": "super cool ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + }, + { + "id": 432, + "name": "Another ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/432" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/432" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" } ] }, + "org-ruleset": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + }, + "rule-suite-items": { + "value": [ + { + "id": 21, + "actor_id": 12, + "actor_name": "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, + "actor_name": "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, + "actor_name": "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" + } + ] + } + }, "team-full": { "value": { "id": 1, @@ -251505,6 +266990,7 @@ "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", @@ -252144,6 +267630,7 @@ "slug": "original-roster", "description": "Started it all.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/2/members{/member}", "repositories_url": "https://api.github.com/teams/2/repos", @@ -252156,6 +267643,7 @@ "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" @@ -252383,6 +267871,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -252628,6 +268122,7 @@ "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, + "allow_forking": true, "subscribers_count": 42, "network_count": 0, "license": { @@ -252908,6 +268403,9 @@ }, "secret_scanning_push_protection": { "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" } } } @@ -253842,6 +269340,7 @@ "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", @@ -253954,6 +269453,39 @@ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" } }, + "activity-items": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "before": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "after": "827efc6d56897b048c772eb4087f854f46256132", + "ref": "refs/heads/main", + "pushed_at": "2011-01-26T19:06:43Z", + "push_type": "normal", + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, "autolink-items": { "value": [ { @@ -254020,9 +269552,7 @@ "comment_count": 77, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", @@ -254150,6 +269680,7 @@ "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", @@ -254236,6 +269767,7 @@ "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", @@ -254417,6 +269949,7 @@ "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", @@ -254521,6 +270054,7 @@ "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", @@ -254636,9 +270170,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "comment_count": 0 }, @@ -256098,7 +271630,8 @@ "python" ], "query_suite": "default", - "updated_at": "2023-01-19T11:21:34Z" + "updated_at": "2023-01-19T11:21:34Z", + "schedule": "weekly" } }, "code-scanning-default-setup-update": { @@ -256126,6 +271659,32 @@ "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" } }, + "code-security-configuration-for-repository": { + "value": { + "status": "attached", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + }, "codeowners-errors": { "value": { "errors": [ @@ -256601,6 +272160,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -256961,9 +272521,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -257389,9 +272947,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -257467,9 +273023,7 @@ "comment_count": 0, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } }, "author": { @@ -257817,9 +273371,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -257871,16 +273423,13 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } }, "file-commit": { "value": { - "content": null, "commit": { "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", @@ -257910,9 +273459,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } } @@ -257989,6 +273536,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -258122,6 +273679,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -258233,6 +273800,16 @@ "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", "score": 5.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, "cwes": [ { "cwe_id": "CWE-532", @@ -258332,6 +273909,16 @@ "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", "score": 7.5 }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, "cwes": [ { "cwe_id": "CWE-200", @@ -258491,10 +274078,7 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { "SPDXID": "SPDXRef-Package", @@ -258502,8 +274086,20 @@ "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, - "licenseConcluded": "MIT", - "licenseDeclared": "MIT" + "licenseConcluded": "NOASSERTION", + "licenseDeclared": "NOASSERTION" + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -258738,6 +274334,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -258790,7 +274387,7 @@ ], "deployment_branch_policy": { "protected_branches": false, - "custom_branch_policies": true + "custom_branch_policies": "trues" } } ] @@ -258815,6 +274412,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -258902,6 +274500,83 @@ "name": "main" } }, + "deployment-branch-policy-single-tag": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "v1", + "type": "tag" + } + }, + "deployment-protection-rules": { + "value": [ + { + "total_count": 2 + }, + { + "custom_deployment_protection_rules": [ + { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + }, + { + "id": 4, + "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", + "enabled": true, + "app": { + "id": 1, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + } + ] + } + ] + }, + "deployment-protection-rule": { + "value": { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + } + }, + "custom-deployment-protection-rule-apps": { + "value": [ + { + "total_count": 2 + }, + { + "available_custom_deployment_protection_rule_integrations": [ + { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + }, + { + "id": 2, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + ] + } + ] + }, "repo-events-items": { "value": [ { @@ -259130,9 +274805,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" }, "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" } @@ -259167,9 +274840,7 @@ ], "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -259228,9 +274899,7 @@ }, "verification": { "verified": false, - "reason": "unsigned", - "signature": null, - "payload": null + "reason": "unsigned" } } }, @@ -260613,19 +276282,21 @@ ] }, "deploy-key-items": { - "value": [ - { - "id": 1, - "key": "ssh-rsa AAA...", - "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", - "title": "octocat@octomac", - "verified": true, - "created_at": "2014-12-10T15:53:42Z", - "read_only": true, - "added_by": "octocat", - "last_used": "2022-01-10T15:53:42Z" - } - ] + "value": { + "enabled": [ + { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z" + } + ] + } }, "deploy-key": { "value": { @@ -260794,6 +276465,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -260881,10 +276554,16 @@ }, "page-deployment": { "value": { - "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251", + "id": "4fd754f7e594640989b406850d0bc8f06a121251", + "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", "page_url": "developer.github.com" } }, + "pages-deployment-status": { + "value": { + "status": "succeed" + } + }, "repository-pre-receive-hook-items": { "value": [ { @@ -260949,6 +276628,40 @@ } ] }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "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", @@ -261136,6 +276849,7 @@ "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" @@ -261451,6 +277165,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false, "merged": false, "mergeable": true, @@ -261776,6 +277491,7 @@ "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", @@ -262011,6 +277727,7 @@ "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", @@ -262340,6 +278057,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false } }, @@ -262530,6 +278248,7 @@ "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", @@ -262632,6 +278351,7 @@ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", + "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, @@ -262662,6 +278382,7 @@ "pull": true }, "allow_rebase_merge": true, + "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, @@ -262778,6 +278499,7 @@ "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", + "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, @@ -262808,6 +278530,7 @@ "pull": true }, "allow_rebase_merge": true, + "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, @@ -262855,6 +278578,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false } }, @@ -263410,6 +279134,118 @@ } } }, + "repository-rule-items": { + "value": [ + { + "type": "commit_message_pattern", + "ruleset_source_type": "Repository", + "ruleset_source": "monalisa/my-repo", + "ruleset_id": 42, + "parameters": { + "operator": "starts_with", + "pattern": "issue" + } + }, + { + "type": "commit_author_email_pattern", + "ruleset_source_type": "Organization", + "ruleset_source": "my-org", + "ruleset_id": 73, + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + }, + "repository-ruleset-items": { + "value": [ + { + "id": 42, + "name": "super cool ruleset", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/42" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + }, + { + "id": 314, + "name": "Another ruleset", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/314" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/314" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + ] + }, + "repository-ruleset": { + "value": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/42" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + } + }, "secret-scanning-alert-list": { "value": [ { @@ -263466,7 +279302,31 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "inactive" }, { "number": 1, @@ -263484,7 +279344,12 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown" } ] }, @@ -263499,7 +279364,8 @@ "secret_type": "mailchimp_api_key", "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "push_protection_bypassed": false + "push_protection_bypassed": false, + "validity": "unknown" } }, "secret-scanning-alert-resolved": { @@ -263536,7 +279402,8 @@ "secret_type_display_name": "Mailchimp API Key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "push_protection_bypassed": false, - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "unknown" } }, "secret-scanning-location-list": { @@ -263608,7 +279475,7 @@ { "type": "pull_request_title", "details": { - "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pull/2846" + "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" } }, { @@ -263637,6 +279504,13 @@ } ] }, + "secret-scanning-push-protection-bypass": { + "value": { + "reason": "will_fix_later", + "expire_at": "2020-11-06T18:18:30Z", + "token_type": "mailchimp_api_key" + } + }, "simple-user-items-default-response": { "summary": "Default response", "value": [ @@ -264286,7 +280160,7 @@ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159", - "id": "927fa2c08dcb4a7fae9e", + "id": "24b28bbb-5fc4-4686-a153-a020debb1155", "displayName": "Engineering", "members": [ { @@ -264304,7 +280178,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } ], @@ -264336,7 +280210,7 @@ "resourceType": "Group", "created": "2012-03-27T19:59:26.000Z", "lastModified": "2018-03-27T19:59:26.000Z", - "location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e" + "location": "https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155" } } }, @@ -265052,215 +280926,6 @@ ] } }, - "configuration-status": { - "value": { - "status": "running", - "progress": [ - { - "status": "DONE", - "key": "Appliance core components" - }, - { - "status": "DONE", - "key": "GitHub utilities" - }, - { - "status": "DONE", - "key": "GitHub applications" - }, - { - "status": "CONFIGURING", - "key": "GitHub services" - }, - { - "status": "PENDING", - "key": "Reloading appliance services" - } - ] - } - }, - "maintenance-status": { - "value": { - "status": "scheduled", - "scheduled_time": "Tuesday, January 22 at 15:34 -0800", - "connection_services": [ - { - "name": "git operations", - "number": 0 - }, - { - "name": "mysql queries", - "number": 233 - }, - { - "name": "aqueduct jobs", - "number": 34 - }, - { - "name": "resque jobs", - "number": 54 - } - ] - } - }, - "enterprise-settings": { - "value": { - "enterprise": { - "private_mode": false, - "public_pages": false, - "subdomain_isolation": true, - "signup_enabled": false, - "github_hostname": "ghe.local", - "identicons_host": "dotcom", - "http_proxy": null, - "auth_mode": "default", - "expire_sessions": false, - "admin_password": null, - "configuration_id": 1401777404, - "configuration_run_count": 4, - "avatar": { - "enabled": false, - "uri": "" - }, - "customer": { - "name": "GitHub", - "email": "stannis@themannis.biz", - "uuid": "af6cac80-e4e1-012e-d822-1231380e52e9", - "secret_key_data": "-----BEGIN PGP PRIVATE KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\n-----END PGP PRIVATE KEY BLOCK-----\n", - "public_key_data": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1.4.10 (GNU/Linux)\n\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\n-----END PGP PUBLIC KEY BLOCK-----\n" - }, - "license": { - "seats": 0, - "evaluation": false, - "perpetual": false, - "unlimited_seating": true, - "support_key": "ssh-rsa AAAAB3N....", - "ssh_allowed": true, - "cluster_support": false, - "expire_at": "2016-04-27T00:00:00-07:00" - }, - "github_ssl": { - "enabled": false, - "cert": null, - "key": null - }, - "ldap": { - "host": null, - "port": 0, - "base": [], - "uid": null, - "bind_dn": null, - "password": null, - "method": "Plain", - "search_strategy": "detect", - "user_groups": [], - "admin_group": null, - "virtual_attribute_enabled": false, - "recursive_group_search": false, - "posix_support": true, - "user_sync_emails": false, - "user_sync_keys": false, - "user_sync_interval": 4, - "team_sync_interval": 4, - "sync_enabled": false, - "reconciliation": { - "user": null, - "org": null - }, - "profile": { - "uid": "uid", - "name": null, - "mail": null, - "key": null - } - }, - "cas": { - "url": null - }, - "saml": { - "sso_url": null, - "certificate": null, - "certificate_path": null, - "issuer": null, - "idp_initiated_sso": false, - "disable_admin_demote": false - }, - "github_oauth": { - "client_id": "12313412", - "client_secret": "kj123131132", - "organization_name": "Homestar Runners", - "organization_team": "homestarrunners/characters" - }, - "smtp": { - "enabled": true, - "address": "smtp.example.com", - "authentication": "plain", - "port": "1234", - "domain": "blah", - "username": "foo", - "user_name": "mr_foo", - "enable_starttls_auto": true, - "password": "bar", - "discard-to-noreply-address": true, - "support_address": "enterprise@github.com", - "support_address_type": "email", - "noreply_address": "noreply@github.com" - }, - "ntp": { - "primary_server": "0.pool.ntp.org", - "secondary_server": "1.pool.ntp.org" - }, - "timezone": null, - "snmp": { - "enabled": false, - "community": "" - }, - "syslog": { - "enabled": false, - "server": null, - "protocol_name": "udp" - }, - "assets": null, - "pages": { - "enabled": true - }, - "collectd": { - "enabled": false, - "server": null, - "port": 0, - "encryption": null, - "username": null, - "password": null - }, - "mapping": { - "enabled": true, - "tileserver": null, - "basemap": "company.map-qsz2zrvs", - "token": null - }, - "load_balancer": null - }, - "run_list": [ - "recipe[enterprise-configure]" - ] - } - }, - "ssh-key-items": { - "value": [ - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - }, - { - "key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB...", - "pretty-print": "ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64" - } - ] - }, "team-repository-alternative-response-with-extra-repository-information": { "value": { "id": 1296269, @@ -266849,7 +282514,6 @@ "blog": "https://github.com/blog", "location": "San Francisco", "email": "octocat@github.com", - "is_verified": true, "has_organization_projects": true, "has_repository_projects": true, "public_repos": 2, @@ -266858,9 +282522,9 @@ "following": 0, "html_url": "https://github.com/octocat", "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", "type": "Organization" - } + }, + "ldap_dn": "uid=asdf,ou=users,dc=github,dc=com" } ] }, @@ -268885,9 +284549,6 @@ "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, "secret_type": "mailchimp_api_key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" }, @@ -269031,7 +284692,7 @@ "parameters": { "per-page": { "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -269040,7 +284701,7 @@ }, "page": { "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -269133,6 +284794,33 @@ "type": "integer" } }, + "pagination-before": { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "pagination-after": { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "ghsa_id": { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "cursor": { "name": "cursor", "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", @@ -269284,7 +284972,7 @@ }, "audit-log-enterprise-phrase": { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log).", "in": "query", "required": false, "schema": { @@ -269307,7 +284995,7 @@ }, "audit-log-after": { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor.", "in": "query", "required": false, "schema": { @@ -269316,7 +285004,7 @@ }, "audit-log-before": { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor.", "in": "query", "required": false, "schema": { @@ -269354,24 +285042,6 @@ "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" } }, - "pagination-before": { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - "pagination-after": { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, "dependabot-alert-comma-separated-states": { "name": "state", "in": "query", @@ -269468,7 +285138,7 @@ "secret-scanning-alert-secret-type": { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", "required": false, "schema": { "type": "string" @@ -269497,6 +285167,15 @@ "default": "created" } }, + "secret-scanning-alert-validity": { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, "enterprise-security-product": { "name": "security_product", "in": "path", @@ -269506,9 +285185,11 @@ "type": "string", "enum": [ "advanced_security", + "advanced_security_user_namespace", "dependabot_alerts", "secret_scanning", - "secret_scanning_push_protection" + "secret_scanning_push_protection", + "secret_scanning_non_provider_patterns" ] } }, @@ -269540,7 +285221,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "labels": { @@ -269552,6 +285234,15 @@ "type": "string" } }, + "license-apply": { + "name": "apply", + "description": "Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, "uuid": { "name": "uuid", "description": "The UUID which identifies a node.", @@ -269620,7 +285311,7 @@ }, "thread-id": { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "path", "required": true, "schema": { @@ -269665,7 +285356,7 @@ }, "variables-per-page": { "name": "per_page", - "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", "in": "query", "schema": { "type": "integer", @@ -269683,13 +285374,22 @@ }, "audit-log-phrase": { "name": "phrase", - "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", + "description": "A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log).", "in": "query", "required": false, "schema": { "type": "string" } }, + "configuration-id": { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "role-id": { "name": "role_id", "description": "The unique identifier of the role.", @@ -269708,6 +285408,24 @@ "type": "integer" } }, + "members-per-page": { + "name": "per_page", + "description": "The number of results per page for the \"members\" array (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + "members-page": { + "name": "page", + "description": "The page number of the \"members\" array results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, "migration-id": { "name": "migration_id", "description": "The unique identifier of the migration.", @@ -269726,9 +285444,18 @@ "type": "string" } }, + "team-slug": { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "package-visibility": { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", "in": "query", "required": false, "schema": { @@ -269775,29 +285502,180 @@ "type": "integer" } }, - "secret-scanning-pagination-before-org-repo": { - "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/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.", + "personal-access-token-sort": { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + "personal-access-token-owner": { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "example": "owner[]=octocat1,owner[]=octocat2" + } + }, + "personal-access-token-repository": { + "name": "repository", + "description": "The name of the repository to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "Hello-World" + } + }, + "personal-access-token-permission": { + "name": "permission", + "description": "The permission to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "issues_read" + } + }, + "personal-access-token-before": { + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "personal-access-token-after": { + "name": "last_used_after", + "description": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "fine-grained-personal-access-token-id": { + "name": "pat_id", + "description": "The unique identifier of the fine-grained personal access token.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "custom-property-name": { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, "schema": { "type": "string" } }, - "secret-scanning-pagination-after-org-repo": { - "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/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.", + "ruleset-targets": { + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "branch,tag,push" + } + }, + "ref-in-query": { + "name": "ref", + "description": "The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "query", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + "repository-name-in-query": { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + "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" } }, - "team-slug": { - "name": "team_slug", - "description": "The slug of the team name.", + "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-server@3.15/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-pagination-after-org-repo": { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/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.", + "in": "query", + "required": false, "schema": { "type": "string" } @@ -269985,7 +285863,7 @@ }, "event": { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.15/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "query", "required": false, "schema": { @@ -270019,7 +285897,7 @@ }, "created": { "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", "in": "query", "required": false, "schema": { @@ -270099,7 +285977,7 @@ }, "branch": { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql).", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.15/graphql).", "in": "path", "required": true, "schema": { @@ -270239,6 +286117,15 @@ "type": "integer" } }, + "protection-rule-id": { + "name": "protection_rule_id", + "description": "The unique identifier of the protection rule.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "git-ref-only": { "name": "ref", "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", @@ -270300,6 +286187,22 @@ "type": "integer" } }, + "pages-deployment-id": { + "name": "pages_deployment_id", + "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + }, "pull-number": { "name": "pull_number", "description": "The number that identifies the pull request.", @@ -270473,6 +286376,15 @@ "default": "created" } }, + "account-id": { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "since-user": { "name": "since", "description": "A user ID. Only return users with an ID greater than this ID.", @@ -270529,22 +286441,22 @@ } }, "responses": { - "not_found": { - "description": "Resource not found", + "validation_failed_simple": { + "description": "Validation failed, or the endpoint has been spammed.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/basic-error" + "$ref": "#/components/schemas/validation-error-simple" } } } }, - "validation_failed_simple": { - "description": "Validation failed, or the endpoint has been spammed.", + "not_found": { + "description": "Resource not found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/validation-error-simple" + "$ref": "#/components/schemas/basic-error" } } } @@ -270622,6 +286534,34 @@ } } }, + "actions_runner_jitconfig": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "$ref": "#/components/schemas/runner" + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-jitconfig" + } + } + } + } + }, "actions_runner_labels": { "description": "Response", "content": { @@ -270703,16 +286643,6 @@ } } }, - "code_scanning_forbidden_read": { - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/basic-error" - } - } - } - }, "forbidden_gist": { "description": "Forbidden Gist", "content": { @@ -270766,9 +286696,22 @@ } } }, + "no_content": { + "description": "A header with no content is returned." + }, "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, + "internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "temporary_redirect": { "description": "Temporary Redirect", "content": { @@ -270779,8 +286722,8 @@ } } }, - "internal_error": { - "description": "Internal Error", + "code_scanning_forbidden_read": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", "content": { "application/json": { "schema": { @@ -270832,9 +286775,6 @@ } } }, - "no_content": { - "description": "A header with no content is returned." - }, "scim_bad_request": { "description": "Bad request", "content": { diff --git a/cache/github.ae.json b/cache/github.ae.json index ba2cc5857..6cc979c6b 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "16.6.0", + "version": "17.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": { diff --git a/package.json b/package.json index fb623c82f..f97a74bee 100644 --- a/package.json +++ b/package.json @@ -46,25 +46,25 @@ [ "@semantic-release/npm", { - "pkgRoot": "packages/openapi-types-ghes-3.10" + "pkgRoot": "packages/openapi-types-ghes-3.12" } ], [ "@semantic-release/npm", { - "pkgRoot": "packages/openapi-types-ghes-3.11" + "pkgRoot": "packages/openapi-types-ghes-3.13" } ], [ "@semantic-release/npm", { - "pkgRoot": "packages/openapi-types-ghes-3.12" + "pkgRoot": "packages/openapi-types-ghes-3.14" } ], [ "@semantic-release/npm", { - "pkgRoot": "packages/openapi-types-ghes-3.9" + "pkgRoot": "packages/openapi-types-ghes-3.15" } ], [ diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json index fce8890a8..d3db96544 100644 --- a/packages/openapi-types-ghec/package.json +++ b/packages/openapi-types-ghec/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.6.0" + "openapi-version": "17.1.0" } } diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index 96be55a38..623d34240 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -138,8 +138,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -163,7 +161,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; @@ -171,17 +169,17 @@ export interface paths { "/applications/{client_id}/token": { /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -193,17 +191,14 @@ export interface paths { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; }; @@ -634,7 +629,7 @@ export interface paths { * Get the audit log for an enterprise * @description Gets the audit log for an enterprise. * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." * * The authenticated user must be an enterprise admin to use this endpoint. * @@ -642,6 +637,55 @@ export interface paths { */ get: operations["enterprise-admin/get-audit-log"]; }; + "/enterprises/{enterprise}/audit-log/stream-key": { + /** + * Get the audit log stream key for encrypting secrets + * @description Retrieves the audit log streaming public key for encrypting secrets. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + get: operations["enterprise-admin/get-audit-log-stream-key"]; + }; + "/enterprises/{enterprise}/audit-log/streams": { + /** + * List audit log stream configurations for an enterprise + * @description Lists the configured audit log streaming configurations for an enterprise. + * This only lists configured streams for supported providers. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + get: operations["enterprise-admin/get-audit-log-streams"]; + /** + * Create an audit log streaming configuration for an enterprise + * @description Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + post: operations["enterprise-admin/create-audit-log-stream"]; + }; + "/enterprises/{enterprise}/audit-log/streams/{stream_id}": { + /** + * List one audit log streaming configuration via a stream ID + * @description Lists one audit log stream configuration via a stream ID. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + get: operations["enterprise-admin/get-one-audit-log-stream"]; + /** + * Update an existing audit log stream configuration + * @description Updates an existing audit log stream configuration for an enterprise. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + put: operations["enterprise-admin/update-audit-log-stream"]; + /** + * Delete an audit log streaming configuration for an enterprise + * @description Deletes an existing audit log stream configuration for an enterprise. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + delete: operations["enterprise-admin/delete-audit-log-stream"]; + }; "/enterprises/{enterprise}/code-scanning/alerts": { /** * List code scanning alerts for an enterprise @@ -653,19 +697,126 @@ export interface paths { */ get: operations["code-scanning/list-alerts-for-enterprise"]; }; + "/enterprises/{enterprise}/code-security/configurations": { + /** + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/create-configuration-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/defaults": { + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + patch: operations["code-security/update-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-enterprise-configuration"]; + }; "/enterprises/{enterprise}/code_security_and_analysis": { /** * Get code security and analysis features for an enterprise - * @description Gets code security and analysis settings for the specified enterprise. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + * + * Gets code security and analysis settings for the specified enterprise. * * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ get: operations["secret-scanning/get-security-analysis-settings-for-enterprise"]; /** * Update code security and analysis features for an enterprise - * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + * + * Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. * * The authenticated user must be an administrator of the enterprise to use this endpoint. * @@ -684,23 +835,62 @@ export interface paths { */ get: operations["enterprise-admin/get-consumed-licenses"]; }; + "/enterprises/{enterprise}/copilot/billing/seats": { + /** + * List all Copilot seat assignments for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * + * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + * + * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * + * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * + * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/list-copilot-seats-for-enterprise"]; + }; + "/enterprises/{enterprise}/copilot/metrics": { + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise"]; + }; "/enterprises/{enterprise}/copilot/usage": { /** * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-enterprise"]; }; @@ -728,6 +918,85 @@ export interface paths { */ get: operations["enterprise-admin/get-license-sync-status"]; }; + "/enterprises/{enterprise}/properties/schema": { + /** + * Get custom properties for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all custom properties defined for an enterprise. + * Enterprise members can read these properties. + */ + get: operations["enterprise-admin/get-enterprise-custom-properties"]; + /** + * Create or update custom properties for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates new or updates existing custom properties defined for an enterprise in a batch. + * + * To use this endpoint, the authenticated user must be an administrator for the enterprise. + */ + patch: operations["enterprise-admin/create-or-update-enterprise-custom-properties"]; + }; + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { + /** + * Get a custom property for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a custom property that is defined for an enterprise. + * Enterprise members can read these properties. + */ + get: operations["enterprise-admin/get-enterprise-custom-property"]; + /** + * Create or update a custom property for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a new or updates an existing custom property that is defined for an enterprise. + * + * To use this endpoint, the authenticated user must be an administrator for the enterprise. + */ + put: operations["enterprise-admin/create-or-update-enterprise-custom-property"]; + /** + * Remove a custom property for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Remove a custom property that is defined for an enterprise. + * + * To use this endpoint, the authenticated user must be an administrator for the enterprise. + */ + delete: operations["enterprise-admin/remove-enterprise-custom-property"]; + }; + "/enterprises/{enterprise}/rulesets": { + /** + * Create an enterprise repository ruleset + * @description Create a repository ruleset for an enterprise. + */ + post: operations["repos/create-enterprise-ruleset"]; + }; + "/enterprises/{enterprise}/rulesets/{ruleset_id}": { + /** + * Get an enterprise repository ruleset + * @description Get a repository ruleset for an enterprise. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + get: operations["repos/get-enterprise-ruleset"]; + /** + * Update an enterprise repository ruleset + * @description Update a ruleset for an enterprise. + */ + put: operations["repos/update-enterprise-ruleset"]; + /** + * Delete an enterprise repository ruleset + * @description Delete a ruleset for an enterprise. + */ + delete: operations["repos/delete-enterprise-ruleset"]; + }; "/enterprises/{enterprise}/secret-scanning/alerts": { /** * List secret scanning alerts for an enterprise @@ -758,6 +1027,29 @@ export interface paths { */ get: operations["billing/get-github-advanced-security-billing-ghe"]; }; + "/enterprises/{enterprise}/settings/billing/cost-centers": { + /** + * Get all cost centers for an enterprise + * @description Gets a list of all the cost centers for an enterprise. + */ + get: operations["billing/get-all-cost-centers"]; + }; + "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource": { + /** + * Add users to a cost center + * @description Adds users to a cost center. + * + * The usage for the users will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. + */ + post: operations["billing/add-resource-to-cost-center"]; + /** + * Remove users from a cost center + * @description Remove users from a cost center. + * + * The usage for the users will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. + */ + delete: operations["billing/remove-resource-from-cost-center"]; + }; "/enterprises/{enterprise}/settings/billing/packages": { /** * Get GitHub Packages billing for an enterprise @@ -780,10 +1072,68 @@ export interface paths { */ get: operations["billing/get-shared-storage-billing-ghe"]; }; + "/enterprises/{enterprise}/settings/billing/usage": { + /** + * Get billing usage report for an enterprise + * @description Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. + * + * **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-ghe"]; + }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + /** + * Get Copilot metrics for an enterprise team + * @description > [!NOTE] + * > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + * + * Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-enterprise-team"]; + }; + "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + * + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + * See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise-team"]; + }; "/enterprises/{enterprise}/{security_product}/{enablement}": { /** * Enable or disable a security feature - * @description Enables or disables the specified security feature for all repositories in an enterprise. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + * + * Enables or disables the specified security feature for all repositories in an enterprise. * * The authenticated user must be an administrator of the enterprise to use this endpoint. * @@ -794,7 +1144,8 @@ export interface paths { "/events": { /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; }; @@ -813,7 +1164,8 @@ export interface paths { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -827,7 +1179,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; }; @@ -986,10 +1339,8 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1030,7 +1381,7 @@ export interface paths { * Get a subscription plan for an account * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account"]; }; @@ -1039,7 +1390,7 @@ export interface paths { * List plans * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans"]; }; @@ -1048,7 +1399,7 @@ export interface paths { * List accounts for a plan * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan"]; }; @@ -1057,7 +1408,7 @@ export interface paths { * Get a subscription plan for an account (stubbed) * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account-stubbed"]; }; @@ -1066,7 +1417,7 @@ export interface paths { * List plans (stubbed) * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans-stubbed"]; }; @@ -1075,7 +1426,7 @@ export interface paths { * List accounts for a plan (stubbed) * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan-stubbed"]; }; @@ -1088,12 +1439,17 @@ export interface paths { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; }; "/notifications": { @@ -1160,16 +1516,17 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; }; "/organizations/{organization_id}/custom_roles": { /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -1179,6 +1536,15 @@ export interface paths { */ get: operations["orgs/list-custom-roles"]; }; + "/organizations/{org}/settings/billing/usage": { + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + }; "/orgs/{org}": { /** * Get an organization @@ -1188,17 +1554,6 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. @@ -1217,20 +1572,13 @@ export interface paths { delete: operations["orgs/delete"]; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -1894,6 +2242,17 @@ export interface paths { */ patch: operations["announcement-banners/set-announcement-banner-for-org"]; }; + "/orgs/{org}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["orgs/list-attestations"]; + }; "/orgs/{org}/audit-log": { /** * Get the audit log for an organization @@ -1903,7 +2262,7 @@ export interface paths { * * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -1935,6 +2294,13 @@ export interface paths { */ delete: operations["orgs/unblock-user"]; }; + "/orgs/{org}/bypass-requests/push-rules": { + /** + * List push rule bypass requests within an organization + * @description Lists the requests made by users of a repository to bypass push protection rules within an organization. + */ + get: operations["orgs/list-push-bypass-requests"]; + }; "/orgs/{org}/code-scanning/alerts": { /** * List code scanning alerts for an organization @@ -1946,6 +2312,117 @@ export interface paths { */ get: operations["code-scanning/list-alerts-for-org"]; }; + "/orgs/{org}/code-security/configurations": { + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-org"]; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/create-configuration"]; + }; + "/orgs/{org}/code-security/configurations/defaults": { + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations"]; + }; + "/orgs/{org}/code-security/configurations/detach": { + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configuration"]; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["code-security/update-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + }; "/orgs/{org}/codespaces": { /** * List codespaces for the organization @@ -2069,116 +2546,141 @@ export interface paths { "/orgs/{org}/copilot/billing": { /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. + * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; }; "/orgs/{org}/copilot/billing/seats": { /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; }; "/orgs/{org}/copilot/billing/selected_teams": { /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Only organization owners can cancel Copilot seats for their organization members. * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * The response contains the total number of seats set to "pending cancellation". * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; }; "/orgs/{org}/copilot/billing/selected_users": { /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * Only organization owners can cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; }; + "/orgs/{org}/copilot/metrics": { + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + }; "/orgs/{org}/copilot/usage": { /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. + * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-org"]; }; @@ -2256,10 +2758,10 @@ export interface paths { }; "/orgs/{org}/custom_roles": { /** - * Deprecated - Create a custom role + * Closing down - Create a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. * * Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -2271,10 +2773,10 @@ export interface paths { }; "/orgs/{org}/custom_roles/{role_id}": { /** - * Deprecated - Get a custom role + * Closing down - Get a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. * * Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -2284,10 +2786,10 @@ export interface paths { */ get: operations["orgs/get-custom-role"]; /** - * Deprecated - Delete a custom role + * Closing down - Delete a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. * * Deletes a custom role from an organization. Once the custom role has been deleted, any * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." @@ -2298,10 +2800,10 @@ export interface paths { */ delete: operations["orgs/delete-custom-role"]; /** - * Deprecated - Update a custom role + * Closing down - Update a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. * * Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -2486,7 +2988,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; }; "/orgs/{org}/external-group/{group_id}": { @@ -2510,16 +3016,19 @@ export interface paths { "/orgs/{org}/failed_invitations": { /** * List failed organization invitations - * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. + * @description The return hash contains `failed_at` and `failed_reason` fields which + * represent the time at which the invitation failed and the reason for the failure. + * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). */ get: operations["orgs/list-failed-invitations"]; }; "/orgs/{org}/fine_grained_permissions": { /** - * Deprecated - List fine-grained permissions for an organization + * Closing down - List fine-grained permissions for an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. * * Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -2631,6 +3140,69 @@ export interface paths { */ post: operations["orgs/ping-webhook"]; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/subject-stats": { + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats": { + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/time-stats": { + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + }; "/orgs/{org}/installation": { /** * Get an organization installation for the authenticated app @@ -2672,15 +3244,21 @@ export interface paths { "/orgs/{org}/invitations": { /** * List pending organization invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. + * @description The return hash contains a `role` field which refers to the Organization + * Invitation role and will be one of the following values: `direct_member`, `admin`, + * `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud + * member, the `login` field in the return hash will be `null`. + * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). */ get: operations["orgs/list-pending-invitations"]; /** * Create an organization invitation * @description Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + * + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ post: operations["orgs/create-invitation"]; }; @@ -2689,6 +3267,8 @@ export interface paths { * Cancel an organization invitation * @description Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + * * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). */ delete: operations["orgs/cancel-invitation"]; @@ -2696,7 +3276,10 @@ export interface paths { "/orgs/{org}/invitations/{invitation_id}/teams": { /** * List organization invitation teams - * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + * @description List all teams associated with an invitation. In order to see invitations + * in an organization, the authenticated user must be an organization owner. + * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). */ get: operations["orgs/list-invitation-teams"]; }; @@ -2705,10 +3288,8 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -2768,13 +3349,17 @@ export interface paths { "/orgs/{org}/members/{username}/copilot": { /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * Only organization owners can view Copilot seat assignment details for members of their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; }; @@ -2794,7 +3379,7 @@ export interface paths { * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; /** @@ -2878,7 +3463,7 @@ export interface paths { "/orgs/{org}/organization-roles": { /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2890,7 +3475,18 @@ export interface paths { get: operations["orgs/list-org-roles"]; /** * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific + * permissions over the organization and optionally across all repositories in the organization. For + * more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To include repository permissions in an organization role, you must also include the `base_role` + * field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of + * fine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions + * and can only be granted through the base role (like "reading a repo"). If you include repository permissions, those + * permissions apply across all of the repositories in the organization. You do not have to include organization permissions + * in order to add repository permissions. + * + * See "[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. * * To use this endpoint, the authenticated user must be one of: * @@ -2904,7 +3500,7 @@ export interface paths { "/orgs/{org}/organization-roles/teams/{team_slug}": { /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2915,7 +3511,7 @@ export interface paths { "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2924,7 +3520,7 @@ export interface paths { put: operations["orgs/assign-team-to-org-role"]; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2935,7 +3531,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}": { /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2946,7 +3542,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}/{role_id}": { /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2955,7 +3551,7 @@ export interface paths { put: operations["orgs/assign-user-to-org-role"]; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2966,7 +3562,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}": { /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2992,6 +3588,10 @@ export interface paths { * Update a custom organization role * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * + * If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either + * previously or as part of the update. + * If the update sets the `base_role` field to `none`, you must also remove all of the repository + * permissions as well, otherwise the update will fail. * * To use this endpoint, the authenticated user must be one of: * @@ -3005,7 +3605,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}/teams": { /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -3016,7 +3616,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}/users": { /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -3048,7 +3648,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; }; @@ -3057,7 +3657,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; /** @@ -3066,7 +3666,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; }; @@ -3081,7 +3681,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; }; @@ -3090,7 +3690,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; }; @@ -3099,7 +3699,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; /** @@ -3108,7 +3708,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; }; @@ -3123,7 +3723,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; }; @@ -3195,6 +3795,73 @@ export interface paths { */ get: operations["orgs/list-pat-grant-repositories"]; }; + "/orgs/{org}/private-registries": { + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/list-org-private-registries"]; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["private-registries/create-org-private-registry"]; + }; + "/orgs/{org}/private-registries/public-key": { + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + }; + "/orgs/{org}/private-registries/{secret_name}": { + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["private-registries/update-org-private-registry"]; + }; "/orgs/{org}/projects": { /** * List organization projects @@ -3303,7 +3970,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; /** @@ -3357,6 +4025,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -3395,31 +4066,25 @@ export interface paths { "/orgs/{org}/security-managers": { /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; }; "/orgs/{org}/security-managers/teams/{team_slug}": { /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; }; @@ -3476,25 +4141,45 @@ export interface paths { */ get: operations["teams/list-idp-groups-for-org"]; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-team"]; }; @@ -3517,7 +4202,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Cloud replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; /** @@ -3526,14 +4212,16 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; }; @@ -3542,7 +4230,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3551,9 +4240,10 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3564,7 +4254,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3573,7 +4264,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3582,7 +4274,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3593,7 +4286,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3602,9 +4296,10 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3615,7 +4310,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3624,7 +4320,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3633,7 +4330,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3644,7 +4342,8 @@ export interface paths { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3655,7 +4354,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3664,7 +4364,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * @@ -3677,7 +4378,8 @@ export interface paths { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3688,7 +4390,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3697,7 +4400,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * @@ -3733,7 +4437,8 @@ export interface paths { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ get: operations["teams/list-pending-invitations-in-org"]; }; @@ -3753,10 +4458,11 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). */ @@ -3767,13 +4473,15 @@ export interface paths { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; /** @@ -3782,9 +4490,11 @@ export interface paths { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; }; @@ -3793,7 +4503,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; }; @@ -3802,21 +4513,24 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; }; @@ -3825,7 +4539,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; }; @@ -3834,20 +4549,22 @@ export interface paths { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -3856,7 +4573,8 @@ export interface paths { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; }; @@ -3867,7 +4585,8 @@ export interface paths { * * Team synchronization is available for organizations using 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. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ get: operations["teams/list-idp-groups-in-org"]; /** @@ -3876,7 +4595,8 @@ export interface paths { * * Team synchronization is available for organizations using 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. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ patch: operations["teams/create-or-update-idp-group-connections-in-org"]; }; @@ -3885,18 +4605,23 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; }; "/orgs/{org}/{security_product}/{enablement}": { /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -4003,7 +4728,8 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -4014,9 +4740,10 @@ export interface paths { * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/overview/api-versions)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; }; @@ -4025,7 +4752,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; /** @@ -4421,7 +5149,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; }; @@ -4523,8 +5251,8 @@ export interface paths { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -4783,6 +5511,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; }; @@ -4827,6 +5557,28 @@ export interface paths { */ get: operations["issues/check-user-can-be-assigned"]; }; + "/repos/{owner}/{repo}/attestations": { + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["repos/create-attestation"]; + }; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["repos/list-attestations"]; + }; "/repos/{owner}/{repo}/autolinks": { /** * Get all autolinks of a repository @@ -4894,9 +5646,11 @@ export interface paths { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; /** @@ -4943,7 +5697,8 @@ export interface paths { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; }; @@ -4954,7 +5709,8 @@ export interface paths { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; /** @@ -5020,7 +5776,8 @@ export interface paths { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; /** @@ -5138,7 +5895,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -5146,6 +5904,20 @@ export interface paths { */ post: operations["repos/rename-branch"]; }; + "/repos/{owner}/{repo}/bypass-requests/push-rules": { + /** + * List repository push rule bypass requests + * @description Lists the requests made by users of a repository to bypass push protection rules + */ + get: operations["repos/list-repo-push-bypass-requests"]; + }; + "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": { + /** + * Get a repository push bypass request + * @description Get information about a request to bypass push protection rules for a repository. + */ + get: operations["repos/get-repo-push-bypass-request"]; + }; "/repos/{owner}/{repo}/check-runs": { /** * Create a check run @@ -5162,7 +5934,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5171,7 +5944,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -5202,7 +5976,8 @@ export interface paths { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -5221,7 +5996,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5232,7 +6008,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5275,6 +6052,37 @@ export interface paths { */ patch: operations["code-scanning/update-alert"]; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-autofix"]; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/create-autofix"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/commit-autofix"]; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { /** * List instances of a code scanning alert @@ -5298,8 +6106,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -5401,7 +6209,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; }; @@ -5412,13 +6220,52 @@ export interface paths { * * By default this endpoint returns JSON metadata about the CodeQL database. To * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types), and make sure + * to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + delete: operations["code-scanning/delete-codeql-database"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["code-scanning/create-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-variant-analysis-repo-task"]; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { /** @@ -5471,6 +6318,8 @@ export interface paths { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -5482,6 +6331,17 @@ export interface paths { */ get: operations["code-scanning/get-sarif"]; }; + "/repos/{owner}/{repo}/code-security-configuration": { + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + }; "/repos/{owner}/{repo}/codeowners/errors": { /** * List CODEOWNERS errors @@ -5562,8 +6422,6 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; @@ -5620,7 +6478,7 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -5661,7 +6519,8 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -5739,7 +6598,8 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). */ @@ -5758,6 +6618,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5805,7 +6666,7 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -5830,7 +6691,8 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -5848,6 +6710,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5874,7 +6737,8 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. * @@ -5887,7 +6751,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5953,7 +6818,7 @@ export interface paths { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." @@ -5968,6 +6833,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -6023,7 +6889,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -6038,7 +6905,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -6267,7 +7135,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -6278,9 +7147,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -6359,7 +7230,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -6495,7 +7368,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; }; @@ -6506,9 +7380,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; }; @@ -6545,6 +7421,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -6583,6 +7460,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -6611,7 +7489,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -6622,7 +7501,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; }; @@ -6660,6 +7540,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -6694,6 +7575,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -6733,8 +7615,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; }; @@ -6757,7 +7639,12 @@ export interface paths { * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -6814,7 +7701,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; }; @@ -6824,7 +7712,8 @@ export interface paths { * @deprecated * @description View the progress of an import. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -6867,7 +7756,8 @@ export interface paths { * 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6875,7 +7765,8 @@ export interface paths { * @deprecated * @description Stop an import for a repository. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6888,7 +7779,8 @@ 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6900,7 +7792,8 @@ export interface paths { * * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6911,7 +7804,8 @@ export interface paths { * @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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6921,7 +7815,8 @@ export interface paths { * @deprecated * @description List files larger than 100MB found during the import * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6935,7 +7830,8 @@ export interface paths { * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6983,10 +7879,8 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7000,7 +7894,7 @@ export interface paths { * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -7074,7 +7968,8 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). */ @@ -7104,10 +7999,8 @@ export interface paths { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7119,7 +8012,7 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7174,7 +8067,7 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -7251,12 +8144,65 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-sub-issues"]; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { /** * List timeline events for an issue @@ -7582,7 +8528,7 @@ export interface paths { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7654,7 +8600,8 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -7677,7 +8624,7 @@ export interface paths { * * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7732,9 +8679,9 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -7751,7 +8698,7 @@ export interface paths { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -7784,8 +8731,8 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7805,7 +8752,7 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; }; @@ -7843,11 +8790,12 @@ export interface paths { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -7917,9 +8865,8 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7948,6 +8895,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -7987,14 +8935,20 @@ export interface paths { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; /** Delete a release asset */ @@ -8033,9 +8987,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; /** @@ -8091,7 +9044,8 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). */ @@ -8139,6 +9093,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -8194,6 +9151,26 @@ export interface paths { */ get: operations["secret-scanning/list-locations-for-alert"]; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + get: operations["secret-scanning/get-scan-history"]; + }; "/repos/{owner}/{repo}/security-advisories": { /** * List repository security advisories @@ -8264,7 +9241,8 @@ export interface paths { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ post: operations["security-advisories/create-fork"]; }; @@ -8282,11 +9260,10 @@ export interface paths { "/repos/{owner}/{repo}/stats/code_frequency": { /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; }; @@ -8308,7 +9285,8 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; }; @@ -8375,23 +9353,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -8402,7 +9392,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -8484,7 +9476,8 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; }; @@ -8511,18 +9504,14 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Lists provisioned SCIM groups in an enterprise. + * @description Lists provisioned SCIM groups in an enterprise. * * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. */ get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; /** * Provision a SCIM enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Creates a SCIM group for an enterprise. + * @description Creates a SCIM group for an enterprise. * * When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. */ @@ -8531,56 +9520,45 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Gets information about a SCIM group. + * @description Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Replaces an existing provisioned group’s information. + * @description Replaces an existing provisioned group’s information. * * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; /** * Delete a SCIM group from an enterprise - * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. - * - * Deletes a SCIM group from an enterprise. + * @description Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Update a provisioned group’s individual attributes. + * @description Update a provisioned group’s individual attributes. * * To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. * * You can submit group memberships individually or in batches for improved efficiency. * - * **Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here. + * > [!NOTE] + * > Memberships are referenced via a local user id. Ensure users are created before referencing them here. */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; }; "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Lists provisioned SCIM enterprise members. + * @description Lists provisioned SCIM enterprise members. * * When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. */ get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; /** * Provision a SCIM enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Creates an external identity for a new SCIM enterprise user. + * @description Creates an external identity for a new SCIM enterprise user. * * SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. */ @@ -8589,51 +9567,45 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Gets information about a SCIM user. + * @description Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Replaces an existing provisioned user's information. + * @description Replaces an existing provisioned user's information. * * You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. + * > [!WARNING] + * > Setting `active: false` will suspend a user, and their handle and email will be obfuscated. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; /** * Delete a SCIM user from an enterprise - * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. - * - * Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. + * @description Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Update a provisioned user's individual attributes. + * @description Update a provisioned user's individual attributes. * * To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. - * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. - * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user, and their handle and email will be obfuscated. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; }; @@ -8665,7 +9637,10 @@ export interface paths { post: operations["scim/provision-and-invite-user"]; }; "/scim/v2/organizations/{org}/Users/{scim_user_id}": { - /** Get SCIM provisioning information for a user */ + /** + * Get SCIM provisioning information for a user + * @description Gets SCIM provisioning information for a user. + */ get: operations["scim/get-provisioning-information-for-user"]; /** * Update a provisioned organization membership @@ -8673,29 +9648,34 @@ export interface paths { * * You must at least provide the required values for the user: `userName`, `name`, and `emails`. * - * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. + * > [!WARNING] + * > Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ put: operations["scim/set-information-for-provisioned-user"]; - /** Delete a SCIM user from an organization */ + /** + * Delete a SCIM user from an organization + * @description Deletes a SCIM user from an organization. + */ delete: operations["scim/delete-user-from-org"]; /** * Update an attribute for a SCIM user * @description Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. - * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ patch: operations["scim/update-attribute-for-user"]; }; @@ -8753,7 +9733,8 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; }; @@ -8823,13 +9804,15 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -8839,11 +9822,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -8851,7 +9836,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -8861,11 +9847,12 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -8875,7 +9862,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -8885,7 +9873,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -8895,7 +9884,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -8907,7 +9897,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -8917,11 +9908,12 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -8931,7 +9923,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -8941,7 +9934,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -8951,7 +9945,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -8963,7 +9958,8 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * @@ -8973,7 +9969,8 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * @@ -8987,7 +9984,8 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * @@ -8997,7 +9995,8 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * @@ -9011,7 +10010,8 @@ export interface paths { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. */ @@ -9021,7 +10021,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -9031,7 +10032,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -9041,7 +10042,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -9049,7 +10050,8 @@ export interface paths { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -9057,7 +10059,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -9065,7 +10067,8 @@ export interface paths { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; }; @@ -9073,7 +10076,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -9088,13 +10092,15 @@ export interface paths { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -9104,13 +10110,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; }; @@ -9118,7 +10126,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -9128,7 +10137,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -9136,7 +10146,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -9144,7 +10155,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -9154,7 +10166,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; }; @@ -9162,17 +10175,20 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -9182,7 +10198,8 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -9192,7 +10209,8 @@ export interface paths { /** * List IdP groups for a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. * * Team synchronization is available for organizations using 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. * @@ -9202,7 +10220,8 @@ export interface paths { /** * Create or update IdP group connections (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. * * Team synchronization is available for organizations using 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. * @@ -9214,7 +10233,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; }; @@ -9574,11 +10594,15 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -9604,10 +10628,8 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -9761,6 +10783,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -9769,7 +10794,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; }; @@ -9778,14 +10803,14 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; /** * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; }; @@ -9798,7 +10823,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; }; @@ -9807,7 +10832,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; }; @@ -9816,7 +10841,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; /** @@ -9825,7 +10850,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; }; @@ -9838,7 +10863,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; }; @@ -9989,6 +11014,17 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users @@ -10009,6 +11045,17 @@ export interface paths { */ get: operations["users/get-by-username"]; }; + "/users/{username}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["users/list-attestations"]; + }; "/users/{username}/docker/conflicts": { /** * Get list of conflicting packages during Docker migration for user @@ -10021,7 +11068,10 @@ export interface paths { "/users/{username}/events": { /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; }; @@ -10029,11 +11079,18 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; }; "/users/{username}/followers": { @@ -10109,7 +11166,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; }; @@ -10118,7 +11175,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; /** @@ -10127,7 +11184,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; }; @@ -10142,7 +11199,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; }; @@ -10151,7 +11208,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; }; @@ -10160,7 +11217,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; /** @@ -10169,7 +11226,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; }; @@ -10184,7 +11241,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; }; @@ -10198,12 +11255,20 @@ export interface paths { "/users/{username}/received_events": { /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -10448,6 +11513,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ vulnerable_functions: readonly string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -10457,7 +11536,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -10516,6 +11598,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -10615,6 +11699,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -10623,6 +11708,10 @@ export interface components { name: string; }[] | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; /** @description The users who contributed to the advisory. */ credits: | readonly { @@ -10659,7 +11748,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -10718,6 +11810,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * GitHub app @@ -10736,6 +11830,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -10792,8 +11888,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -10889,6 +11983,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -10979,6 +12079,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -11224,7 +12330,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -11259,7 +12365,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -11418,6 +12524,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -11709,7 +12816,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -11822,6 +12929,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -12517,6 +13625,7 @@ export interface components { default: boolean; selected_organizations_url?: string; runners_url: string; + hosted_runners_url?: string; allows_public_repositories: boolean; /** * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. @@ -12721,6 +13830,148 @@ export interface components { /** @description The repository visibility, for example `public` or `private`. */ visibility?: string; }; + /** + * stream-key + * @description Audit Log Streaming Public Key + */ + "audit-log-stream-key": { + key_id: string; + key: string; + }; + /** + * List audit log streaming configurations + * @description Lists the audit log streaming configurations for an enterprise. + */ + "get-audit-log-stream-configs": { + id?: number; + stream_type?: string; + stream_details?: string; + enabled?: boolean; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + /** Format: date-time */ + paused_at?: string | null; + }[]; + /** + * AzureBlobConfig + * @description Azure Blob Config for audit log streaming configuration. + */ + "azure-blob-config": { + /** @description Key ID obtained from the audit log stream key endpoint used to encrypt secrets. */ + key_id: string; + encrypted_sas_url: string; + }; + /** + * AzureHubConfig + * @description Azure Event Hubs Config for audit log streaming configuration. + */ + "azure-hub-config": { + /** @description Instance name of Azure Event Hubs */ + name: string; + /** @description Encrypted Connection String for Azure Event Hubs */ + encrypted_connstring: string; + /** @description Key ID obtained from the audit log stream key endpoint used to encrypt secrets. */ + key_id: string; + }; + /** + * AmazonS3OIDCConfig + * @description Amazon S3 OIDC Config for audit log streaming configuration. + */ + "amazon-s3-oidc-config": { + /** @description Amazon S3 Bucket Name. */ + bucket: string; + /** @description AWS S3 Bucket Region. */ + region: string; + /** @description Key ID obtained from the audit log stream key endpoint used to encrypt secrets. */ + key_id: string; + /** + * @description Authentication Type for Amazon S3. + * @enum {string} + */ + authentication_type: "oidc"; + arn_role: string; + }; + /** + * AmazonS3AccessKeysConfig + * @description Amazon S3 Access Keys Config for audit log streaming configuration. + */ + "amazon-s3-access-keys-config": { + /** @description Amazon S3 Bucket Name. */ + bucket: string; + /** @description Amazon S3 Bucket Name. */ + region: string; + /** @description Key ID obtained from the audit log stream key endpoint used to encrypt secrets. */ + key_id: string; + /** + * @description Authentication Type for Amazon S3. + * @enum {string} + */ + authentication_type: "access_keys"; + /** @description Encrypted AWS Secret Key. */ + encrypted_secret_key: string; + /** @description Encrypted AWS Access Key ID. */ + encrypted_access_key_id: string; + }; + /** + * SplunkConfig + * @description Splunk Config for Audit Log Stream Configuration + */ + "splunk-config": { + /** @description Domain of Splunk instance. */ + domain: string; + /** @description The port number for connecting to Splunk. */ + port: number; + /** @description Key ID obtained from the audit log stream key endpoint used to encrypt secrets. */ + key_id: string; + /** @description Encrypted Token. */ + encrypted_token: string; + /** @description SSL verification helps ensure your events are sent to your Splunk endpoint securely. */ + ssl_verify: boolean; + }; + /** + * GoogleCloudConfig + * @description Google Cloud Config for audit log streaming configuration. + */ + "google-cloud-config": { + /** @description Google Cloud Bucket Name */ + bucket: string; + /** @description Key ID obtained from the audit log stream key endpoint used to encrypt secrets. */ + key_id: string; + encrypted_json_credentials: string; + }; + /** + * DatadogConfig + * @description Datadog Config for audit log streaming configuration. + */ + "datadog-config": { + /** @description Encrypted Splunk token. */ + encrypted_token: string; + /** + * @description Datadog Site to use. + * @enum {string} + */ + site: "US" | "US3" | "US5" | "EU1" | "US1-FED" | "AP1"; + /** @description Key ID obtained from the audit log stream key endpoint used to encrypt secrets. */ + key_id: string; + }; + /** + * Get an audit log streaming configuration + * @description Get an audit log streaming configuration for an enterprise. + */ + "get-audit-log-stream-config": { + id: number; + stream_type: string; + stream_details: string; + enabled: boolean; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + /** Format: date-time */ + paused_at?: string | null; + }; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ @@ -12763,9 +14014,9 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -12781,10 +14032,10 @@ export interface components { * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -12792,8 +14043,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -12806,6 +14055,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -12867,6 +14124,7 @@ export interface components { */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -13120,6 +14378,166 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** + * @description The type of the code security configuration. + * @enum {string} + */ + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; /** Enterprise Security Analysis Settings */ "enterprise-security-analysis-settings": { /** @@ -13156,6 +14574,11 @@ export interface components { * @example https://github.com/test-org/test-repo/blob/main/README.md */ secret_scanning_push_protection_custom_link?: string | null; + /** + * @description Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise. + * @example false + */ + secret_scanning_non_provider_patterns_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise. * @example false @@ -13191,6 +14614,347 @@ export interface components { total_user_accounts?: number; }[]; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members + */ + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + slug: string; + /** Format: uri */ + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league + */ + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. + */ + "copilot-seat-details": { + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: + | components["schemas"]["team"] + | components["schemas"]["enterprise-team"] + | null; + /** + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + pending_cancellation_date?: string | null; + /** + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + created_at: string; + /** + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": { + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + [key: string]: unknown; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": { + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": { + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": { + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + [key: string]: unknown; + }; /** * Copilot Usage Metrics * @description Summary of Copilot usage. @@ -13285,6 +15049,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -13390,6 +15155,656 @@ export interface components { }; }[]; }; + /** + * Organization Custom Property + * @description Custom property defined on an organization + */ + "custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + allowed_values?: string[] | null; + }; + /** + * @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 not available for the `repository` target. + * @enum {string} + */ + "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + /** + * Repository Ruleset Bypass Actor + * @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. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories. */ + actor_id?: number | null; + /** + * @description The type of actor that can bypass a ruleset + * @enum {string} + */ + actor_type: + | "Integration" + | "OrganizationAdmin" + | "RepositoryRole" + | "Team" + | "DeployKey" + | "EnterpriseOwner"; + /** + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always + * @enum {string} + */ + bypass_mode?: "always" | "pull_request"; + }; + /** + * Repository ruleset conditions for organization names + * @description Parameters for an organization name condition + */ + "enterprise-ruleset-conditions-organization-name-target": { + organization_name: { + /** @description Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts. */ + include?: string[]; + /** @description Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + }; + }; + /** + * Repository ruleset conditions for repository names + * @description Parameters for a repository name condition + */ + "repository-ruleset-conditions-repository-name-target": { + repository_name: { + /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ + include?: string[]; + /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + /** @description Whether renaming of target repositories is prevented. */ + protected?: boolean; + }; + }; + /** + * Repository ruleset conditions for ref names + * @description Parameters for a repository ruleset ref name condition + */ + "repository-ruleset-conditions": { + ref_name?: { + /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ + include?: string[]; + /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + }; + }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ + name: string; + /** @description The values to match for the repository property */ + property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; + }; + /** + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition + */ + "repository-ruleset-conditions-repository-property-target": { + repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; + }; + /** + * Repository ruleset conditions for organization IDs + * @description Parameters for an organization ID condition + */ + "enterprise-ruleset-conditions-organization-id-target": { + organization_id: { + /** @description The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ + organization_ids?: number[]; + }; + }; + /** + * Enterprise ruleset conditions + * @description Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property. + */ + "enterprise-ruleset-conditions": + | (components["schemas"]["enterprise-ruleset-conditions-organization-name-target"] & + components["schemas"]["repository-ruleset-conditions-repository-name-target"] & + components["schemas"]["repository-ruleset-conditions"]) + | (components["schemas"]["enterprise-ruleset-conditions-organization-name-target"] & + components["schemas"]["repository-ruleset-conditions-repository-property-target"] & + components["schemas"]["repository-ruleset-conditions"]) + | (components["schemas"]["enterprise-ruleset-conditions-organization-id-target"] & + components["schemas"]["repository-ruleset-conditions-repository-name-target"] & + components["schemas"]["repository-ruleset-conditions"]) + | (components["schemas"]["enterprise-ruleset-conditions-organization-id-target"] & + components["schemas"]["repository-ruleset-conditions-repository-property-target"] & + components["schemas"]["repository-ruleset-conditions"]); + /** + * creation + * @description Only allow users with bypass permission to create matching refs. + */ + "repository-rule-creation": { + /** @enum {string} */ + type: "creation"; + }; + /** + * update + * @description Only allow users with bypass permission to update matching refs. + */ + "repository-rule-update": { + /** @enum {string} */ + type: "update"; + parameters?: { + /** @description Branch can pull changes from its upstream repository */ + update_allows_fetch_and_merge: boolean; + }; + }; + /** + * deletion + * @description Only allow users with bypass permissions to delete matching refs. + */ + "repository-rule-deletion": { + /** @enum {string} */ + type: "deletion"; + }; + /** + * required_linear_history + * @description Prevent merge commits from being pushed to matching refs. + */ + "repository-rule-required-linear-history": { + /** @enum {string} */ + type: "required_linear_history"; + }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; + /** + * required_deployments + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. + */ + "repository-rule-required-deployments": { + /** @enum {string} */ + type: "required_deployments"; + parameters?: { + /** @description The environments that must be successfully deployed to before branches can be merged. */ + required_deployment_environments: string[]; + }; + }; + /** + * required_signatures + * @description Commits pushed to matching refs must have verified signatures. + */ + "repository-rule-required-signatures": { + /** @enum {string} */ + type: "required_signatures"; + }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; + /** + * pull_request + * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. + */ + "repository-rule-pull-request": { + /** @enum {string} */ + type: "pull_request"; + parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; + /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ + dismiss_stale_reviews_on_push: boolean; + /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ + require_code_owner_review: boolean; + /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ + require_last_push_approval: boolean; + /** @description The number of approving reviews that are required before a pull request can be merged. */ + required_approving_review_count: number; + /** @description All conversations on code must be resolved before a pull request can be merged. */ + required_review_thread_resolution: boolean; + }; + }; + /** + * StatusCheckConfiguration + * @description Required status check + */ + "repository-rule-params-status-check-configuration": { + /** @description The status check context name that must be present on the commit. */ + context: string; + /** @description The optional integration ID that this status check must originate from. */ + integration_id?: number; + }; + /** + * required_status_checks + * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. + */ + "repository-rule-required-status-checks": { + /** @enum {string} */ + type: "required_status_checks"; + parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; + /** @description Status checks that are required. */ + required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; + /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ + strict_required_status_checks_policy: boolean; + }; + }; + /** + * non_fast_forward + * @description Prevent users with push access from force pushing to refs. + */ + "repository-rule-non-fast-forward": { + /** @enum {string} */ + type: "non_fast_forward"; + }; + /** + * commit_message_pattern + * @description Parameters to be used for the commit_message_pattern rule + */ + "repository-rule-commit-message-pattern": { + /** @enum {string} */ + type: "commit_message_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * commit_author_email_pattern + * @description Parameters to be used for the commit_author_email_pattern rule + */ + "repository-rule-commit-author-email-pattern": { + /** @enum {string} */ + type: "commit_author_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * committer_email_pattern + * @description Parameters to be used for the committer_email_pattern rule + */ + "repository-rule-committer-email-pattern": { + /** @enum {string} */ + type: "committer_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * branch_name_pattern + * @description Parameters to be used for the branch_name_pattern rule + */ + "repository-rule-branch-name-pattern": { + /** @enum {string} */ + type: "branch_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * tag_name_pattern + * @description Parameters to be used for the tag_name_pattern rule + */ + "repository-rule-tag-name-pattern": { + /** @enum {string} */ + type: "tag_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * RestrictedCommits + * @description Restricted commit + */ + "repository-rule-params-restricted-commits": { + /** @description Full or abbreviated commit hash to reject */ + oid: string; + /** @description Reason for restriction */ + reason?: 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 Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; + /** + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. + */ + "repository-rule-params-code-scanning-tool": { + /** + * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} + */ + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; + /** + * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} + */ + security_alerts_threshold: + | "none" + | "critical" + | "high_or_higher" + | "medium_or_higher" + | "all"; + /** @description The name of a code scanning tool */ + tool: string; + }; + /** + * code_scanning + * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. + */ + "repository-rule-code-scanning": { + /** @enum {string} */ + type: "code_scanning"; + parameters?: { + /** @description Tools that must provide code scanning results for this rule to pass. */ + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; + }; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": + | components["schemas"]["repository-rule-creation"] + | components["schemas"]["repository-rule-update"] + | components["schemas"]["repository-rule-deletion"] + | components["schemas"]["repository-rule-required-linear-history"] + | components["schemas"]["repository-rule-merge-queue"] + | components["schemas"]["repository-rule-required-deployments"] + | components["schemas"]["repository-rule-required-signatures"] + | components["schemas"]["repository-rule-pull-request"] + | components["schemas"]["repository-rule-required-status-checks"] + | components["schemas"]["repository-rule-non-fast-forward"] + | components["schemas"]["repository-rule-commit-message-pattern"] + | 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"] + | { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + } + | { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths */ + max_file_path_length: number; + }; + } + | { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + } + | { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; + }; + } + | components["schemas"]["repository-rule-workflows"] + | components["schemas"]["repository-rule-code-scanning"]; + /** + * Repository ruleset conditions for repository IDs + * @description Parameters for a repository ID condition + */ + "repository-ruleset-conditions-repository-id-target": { + repository_id: { + /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ + repository_ids?: number[]; + }; + }; + /** + * Organization ruleset conditions + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. + */ + "org-ruleset-conditions": + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-name-target"]) + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-id-target"]) + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-property-target"]); + /** + * Repository ruleset + * @description A set of rules to apply when specified conditions are met. + */ + "repository-ruleset": { + /** @description The ID of the ruleset */ + id: number; + /** @description The name of the ruleset */ + name: string; + /** + * @description The target of the ruleset + * @enum {string} + */ + target?: "branch" | "tag" | "push" | "repository"; + /** + * @description The type of the source of the ruleset + * @enum {string} + */ + source_type?: "Repository" | "Organization" | "Enterprise"; + /** @description The name of the source */ + source: string; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + /** + * @description The bypass type of the user making the API request for this ruleset. This field is only returned when + * querying the repository-level endpoint. + * @enum {string} + */ + current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + node_id?: string; + _links?: { + self?: { + /** @description The URL of the ruleset */ + href?: string; + }; + html?: { + /** @description The html URL of the ruleset */ + href?: string; + } | null; + }; + conditions?: + | ( + | components["schemas"]["repository-ruleset-conditions"] + | components["schemas"]["org-ruleset-conditions"] + ) + | null; + rules?: components["schemas"]["repository-rule"][]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -13433,7 +15848,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -13447,6 +15862,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -13454,6 +15879,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo?: boolean | null; }; "actions-billing-usage": { /** @description The sum of the free and paid GitHub Actions minutes used. */ @@ -13526,6 +15955,20 @@ export interface components { purchased_advanced_security_committers?: number; repositories: components["schemas"]["advanced-security-active-committers-repository"][]; }; + "get-all-cost-centers": { + costCenters?: { + /** @description ID of the cost center. */ + id: string; + /** @description Name of the cost center. */ + name: string; + resources: { + /** @description Type of the resource. */ + type: string; + /** @description Name of the resource. */ + name: string; + }[]; + }[]; + }; "packages-billing-usage": { /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ total_gigabytes_bandwidth_used: number; @@ -13542,6 +15985,32 @@ export interface components { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ estimated_storage_for_month: number; }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Actor * @description Actor @@ -13642,6 +16111,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -13698,8 +16169,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -13736,6 +16205,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -13843,6 +16318,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -14002,6 +16478,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -14011,6 +16492,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -14025,7 +16507,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -14056,6 +16540,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -14073,8 +16559,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -14158,6 +16642,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -14183,6 +16668,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -14190,6 +16680,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -14525,18 +17016,49 @@ export interface components { * ] */ actions?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + actions_macos?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + codespaces?: string[]; /** * @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -14560,6 +17082,14 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_ai_detection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; secret_scanning_validity_checks?: { /** @enum {string} */ status?: "enabled" | "disabled"; @@ -14570,7 +17100,10 @@ export interface components { * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14853,7 +17386,12 @@ export interface components { }; /** * Organization Full - * @description Organization Full + * @description Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. + * Removes non-compliant outside collaborators from the organization and its repositories. + * + * GitHub currently defines SMS as an insecure method of two-factor authentication. + * + * If your users are managed by the enterprise this policy will not affect them. The first admin account of the enterprise will still be affected. */ "organization-full": { /** @example github */ @@ -14936,7 +17474,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -14974,47 +17517,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -15031,7 +17587,10 @@ export interface components { */ secret_scanning_push_protection_custom_link?: string | null; /** - * @description Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. * @example false */ secret_scanning_validity_checks_enabled?: boolean; @@ -15044,6 +17603,11 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + deploy_keys_enabled_for_repositories?: boolean; }; /** * Actions Cache Usage by repository @@ -15099,6 +17663,7 @@ export interface components { /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ selected_repositories_url?: string; runners_url: string; + hosted_runners_url?: string; inherited: boolean; inherited_allows_public_repositories?: boolean; allows_public_repositories: boolean; @@ -15202,6 +17767,121 @@ export interface components { */ selected_repositories_url?: string; }; + /** + * Bypass response + * @description A response made by a delegated bypasser to a bypass request. + */ + "bypass-response": { + /** @description The ID of the response to the bypass request. */ + id?: number; + /** @description The user who reviewed the bypass request. */ + reviewer?: { + /** @description The ID of the GitHub user who reviewed the bypass request. */ + actor_id?: number; + /** @description The name of the GitHub user who reviewed the bypass request. */ + actor_name?: string; + }; + /** + * @description The response status to the bypass request until dismissed. + * @enum {string} + */ + status?: "approved" | "denied" | "dismissed"; + /** + * Format: date-time + * @description The date and time the response to the bypass request was created. + */ + created_at?: string; + }; + /** + * Push rule bypass request + * @description A bypass request made by a user asking to be exempted from a push rule in this repository. + */ + "push-rule-bypass-request": { + /** @description The unique identifier of the bypass request. */ + id?: number; + /** @description The number uniquely identifying the bypass request within its repository. */ + number?: number; + /** @description The repository the bypass request is for. */ + repository?: { + /** @description The ID of the repository the bypass request is for. */ + id?: number; + /** @description The name of the repository the bypass request is for. */ + name?: string; + /** @description The full name of the repository the bypass request is for. */ + full_name?: string; + }; + /** @description The organization associated with the repository the bypass request is for. */ + organization?: { + /** @description The ID of the organization. */ + id?: number; + /** @description The name of the organization. */ + name?: string; + }; + /** @description The user who requested the bypass. */ + requester?: { + /** @description The ID of the GitHub user who requested the bypass. */ + actor_id?: number; + /** @description The name of the GitHub user who requested the bypass. */ + actor_name?: string; + }; + /** @description The type of request. */ + request_type?: string; + /** @description Data describing the push rules that are being requested to be bypassed. */ + data?: + | { + /** @description The ID of the ruleset for the rules that were violated. */ + ruleset_id?: number; + /** @description The name of the ruleset for the rules that were violated. */ + ruleset_name?: string; + /** @description The number of rule violations generated from the push associated with this request. */ + total_violations?: number; + /** @description The type of rule that was violated. */ + rule_type?: string; + }[] + | null; + /** + * @description The unique identifier for the request type of the bypass request. For example, a commit SHA. + * @example 827efc6d56897b048c772eb4087f854f46256132 + */ + resource_identifier?: string; + /** + * @description The status of the bypass request. + * @enum {string} + */ + status?: + | "pending" + | "denied" + | "approved" + | "cancelled" + | "completed" + | "expired" + | "open"; + /** @description The comment the requester provided when creating the bypass request. */ + requester_comment?: string | null; + /** + * Format: date-time + * @description The date and time the bypass request will expire. + */ + expires_at?: string; + /** + * Format: date-time + * @description The date and time the bypass request was created. + */ + created_at?: string; + /** @description The responses to the bypass request. */ + responses?: components["schemas"]["bypass-response"][] | null; + /** + * Format: uri + * @example https://api.github.com/repos/octo-org/smile/bypass-requests/push-rules/1 + */ + url?: string; + /** + * Format: uri + * @description The URL to view the bypass request in a browser. + * @example https://github.com/octo-org/smile/exemptions/1 + */ + html_url?: string; + }; /** * @description Severity of a code scanning alert. * @enum {string} @@ -15261,7 +17941,10 @@ export interface components { * @description A codespace. */ codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -15502,8 +18185,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -15536,219 +18219,12 @@ export interface components { | "assign_selected" | "disabled" | "unconfigured"; - [key: string]: unknown; - }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "nullable-team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories - */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; - id: number; - node_id: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - /** - * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com - */ - blog?: string; - /** Format: uri */ - html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; - }; - /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. - */ - "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & ( - | components["schemas"]["simple-user"] - | components["schemas"]["team"] - | components["schemas"]["organization"] - ); - /** @description The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually. */ - assigning_team?: components["schemas"]["team"] | null; - /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. - */ - pending_cancellation_date?: string | null; - /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. - */ - last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - last_activity_editor?: string | null; - /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. - */ - created_at: string; - /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} */ - updated_at?: string; + plan_type?: "business" | "enterprise" | "unknown"; + [key: string]: unknown; }; /** * Credential Authorization @@ -15761,7 +18237,7 @@ export interface components { */ login: string; /** - * @description Unique identifier for the credential. + * @description Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key. * @example 1 */ credential_id: number; @@ -15800,7 +18276,10 @@ export interface components { * @example 2011-01-26T19:06:43Z */ credential_accessed_at: string | null; - /** @example 12345678 */ + /** + * @description The ID of the underlying token that was authorized by the user. This will remain unchanged across authorizations of the token. + * @example 12345678 + */ authorized_credential_id: number | null; /** * @description The title given to the ssh key. This will only be present when the credential is an ssh key. @@ -15890,7 +18369,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -16271,6 +18753,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { + /** Format: int64 */ id: number; login: string | null; email: string | null; @@ -16350,6 +18833,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method?: string; + /** @description The API path's route template */ + api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type?: string; + subject_name?: string; + /** Format: int64 */ + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp?: string; + /** Format: int64 */ + total_request_count?: number; + /** Format: int64 */ + rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; + /** Format: int64 */ + actor_id?: number; + /** Format: int64 */ + integration_id?: number | null; + /** Format: int64 */ + oauth_application_id?: number | null; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -16430,7 +18994,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -16481,12 +19048,25 @@ export interface components { * @description Organization roles */ "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ id: number; /** @description The name of the role. */ name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -16501,6 +19081,212 @@ export interface components { */ updated_at: string; }; + "organization-custom-organization-role-create-schema": { + /** @description The name of the custom role. */ + name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions: string[]; + /** + * @description The system role from which this role can inherit permissions. + * @enum {string} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin"; + }; + "organization-custom-organization-role-update-schema": { + /** @description The name of the custom role. */ + name?: string; + /** @description A short description about the intended use of this role or the permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions?: string[]; + /** + * @description The system role from which this role can inherit permissions. + * @enum {string} + */ + base_role?: "none" | "read" | "triage" | "write" | "maintain" | "admin"; + }; + /** + * A Role Assignment for a Team + * @description The Relationship a Team has with a role. + */ + "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + }; + /** + * A Role Assignment for a User + * @description The Relationship a User has with a role. + */ + "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** @example 1 */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + }; /** * Package Version * @description A version of a software package @@ -16594,6 +19380,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -16606,7 +19396,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -16630,6 +19420,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -16637,6 +19431,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -16698,40 +19554,9 @@ export interface components { * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @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 | string[] | null; - /** @description Short description of the property */ - description?: string | null; - /** - * @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. - */ - allowed_values?: string[] | null; - /** - * @description Who can edit the values of the property - * @example org_actors - * @enum {string|null} - */ - values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + organization_permission?: "read" | "write" | "admin" | "none"; + /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ + private?: boolean; }; /** * Custom Property Value @@ -16763,6 +19588,7 @@ export interface components { */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -17054,7 +19880,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -17138,7 +19964,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -17443,484 +20272,6 @@ export interface components { [key: string]: unknown; }; }; - /** - * @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} - */ - "repository-rule-enforcement": "disabled" | "active" | "evaluate"; - /** - * Repository Ruleset Bypass Actor - * @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. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ - actor_id?: number | null; - /** - * @description The type of actor that can bypass a ruleset. - * - * @enum {string} - */ - actor_type: - | "Integration" - | "OrganizationAdmin" - | "RepositoryRole" - | "Team" - | "DeployKey"; - /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * - * @enum {string} - */ - bypass_mode: "always" | "pull_request"; - }; - /** - * Repository ruleset conditions for ref names - * @description Parameters for a repository ruleset ref name condition - */ - "repository-ruleset-conditions": { - ref_name?: { - /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ - include?: string[]; - /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ - exclude?: string[]; - }; - }; - /** - * Repository ruleset conditions for repository names - * @description Parameters for a repository name condition - */ - "repository-ruleset-conditions-repository-name-target": { - repository_name: { - /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ - include?: string[]; - /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ - exclude?: string[]; - /** @description Whether renaming of target repositories is prevented. */ - protected?: boolean; - }; - }; - /** - * Repository ruleset conditions for repository IDs - * @description Parameters for a repository ID condition - */ - "repository-ruleset-conditions-repository-id-target": { - repository_id: { - /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ - repository_ids?: number[]; - }; - }; - /** - * Repository ruleset property targeting definition - * @description Parameters for a targeting a repository property - */ - "repository-ruleset-conditions-repository-property-spec": { - /** @description The name of the repository property to target */ - name: string; - /** @description The values to match for the repository property */ - property_values: string[]; - }; - /** - * Repository ruleset conditions for repository properties - * @description Parameters for a repository property condition - */ - "repository-ruleset-conditions-repository-property-target": { - repository_property: { - /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ - include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; - /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ - exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; - }; - }; - /** - * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - */ - "org-ruleset-conditions": - | (components["schemas"]["repository-ruleset-conditions"] & - components["schemas"]["repository-ruleset-conditions-repository-name-target"]) - | (components["schemas"]["repository-ruleset-conditions"] & - components["schemas"]["repository-ruleset-conditions-repository-id-target"]) - | (components["schemas"]["repository-ruleset-conditions"] & - components["schemas"]["repository-ruleset-conditions-repository-property-target"]); - /** - * creation - * @description Only allow users with bypass permission to create matching refs. - */ - "repository-rule-creation": { - /** @enum {string} */ - type: "creation"; - }; - /** - * update - * @description Only allow users with bypass permission to update matching refs. - */ - "repository-rule-update": { - /** @enum {string} */ - type: "update"; - parameters?: { - /** @description Branch can pull changes from its upstream repository */ - update_allows_fetch_and_merge: boolean; - }; - }; - /** - * deletion - * @description Only allow users with bypass permissions to delete matching refs. - */ - "repository-rule-deletion": { - /** @enum {string} */ - type: "deletion"; - }; - /** - * required_linear_history - * @description Prevent merge commits from being pushed to matching refs. - */ - "repository-rule-required-linear-history": { - /** @enum {string} */ - type: "required_linear_history"; - }; - /** - * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. - */ - "repository-rule-required-deployments": { - /** @enum {string} */ - type: "required_deployments"; - parameters?: { - /** @description The environments that must be successfully deployed to before branches can be merged. */ - required_deployment_environments: string[]; - }; - }; - /** - * required_signatures - * @description Commits pushed to matching refs must have verified signatures. - */ - "repository-rule-required-signatures": { - /** @enum {string} */ - type: "required_signatures"; - }; - /** - * pull_request - * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. - */ - "repository-rule-pull-request": { - /** @enum {string} */ - type: "pull_request"; - parameters?: { - /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ - dismiss_stale_reviews_on_push: boolean; - /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ - require_code_owner_review: boolean; - /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ - require_last_push_approval: boolean; - /** @description The number of approving reviews that are required before a pull request can be merged. */ - required_approving_review_count: number; - /** @description All conversations on code must be resolved before a pull request can be merged. */ - required_review_thread_resolution: boolean; - }; - }; - /** - * StatusCheckConfiguration - * @description Required status check - */ - "repository-rule-params-status-check-configuration": { - /** @description The status check context name that must be present on the commit. */ - context: string; - /** @description The optional integration ID that this status check must originate from. */ - integration_id?: number; - }; - /** - * required_status_checks - * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. - */ - "repository-rule-required-status-checks": { - /** @enum {string} */ - type: "required_status_checks"; - parameters?: { - /** @description Status checks that are required. */ - required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; - /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ - strict_required_status_checks_policy: boolean; - }; - }; - /** - * non_fast_forward - * @description Prevent users with push access from force pushing to refs. - */ - "repository-rule-non-fast-forward": { - /** @enum {string} */ - type: "non_fast_forward"; - }; - /** - * commit_message_pattern - * @description Parameters to be used for the commit_message_pattern rule - */ - "repository-rule-commit-message-pattern": { - /** @enum {string} */ - type: "commit_message_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * commit_author_email_pattern - * @description Parameters to be used for the commit_author_email_pattern rule - */ - "repository-rule-commit-author-email-pattern": { - /** @enum {string} */ - type: "commit_author_email_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * committer_email_pattern - * @description Parameters to be used for the committer_email_pattern rule - */ - "repository-rule-committer-email-pattern": { - /** @enum {string} */ - type: "committer_email_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * branch_name_pattern - * @description Parameters to be used for the branch_name_pattern rule - */ - "repository-rule-branch-name-pattern": { - /** @enum {string} */ - type: "branch_name_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * tag_name_pattern - * @description Parameters to be used for the tag_name_pattern rule - */ - "repository-rule-tag-name-pattern": { - /** @enum {string} */ - type: "tag_name_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * RestrictedCommits - * @description Restricted commit - */ - "repository-rule-params-restricted-commits": { - /** @description Full or abbreviated commit hash to reject */ - oid: string; - /** @description Reason for restriction */ - reason?: 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"][]; - }; - }; - /** - * CodeScanningTool - * @description A tool that must provide code scanning results for this rule to pass. - */ - "repository-rule-params-code-scanning-tool": { - /** - * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - * @enum {string} - */ - alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; - /** - * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - * @enum {string} - */ - security_alerts_threshold: - | "none" - | "critical" - | "high_or_higher" - | "medium_or_higher" - | "all"; - /** @description The name of a code scanning tool */ - tool: string; - }; - /** - * Repository Rule - * @description A repository rule. - */ - "repository-rule": - | components["schemas"]["repository-rule-creation"] - | components["schemas"]["repository-rule-update"] - | components["schemas"]["repository-rule-deletion"] - | components["schemas"]["repository-rule-required-linear-history"] - | components["schemas"]["repository-rule-required-deployments"] - | components["schemas"]["repository-rule-required-signatures"] - | components["schemas"]["repository-rule-pull-request"] - | components["schemas"]["repository-rule-required-status-checks"] - | components["schemas"]["repository-rule-non-fast-forward"] - | components["schemas"]["repository-rule-commit-message-pattern"] - | 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"] - | { - /** @enum {string} */ - type: "file_path_restriction"; - parameters?: { - /** @description The file paths that are restricted from being pushed to the commit graph. */ - restricted_file_paths: string[]; - }; - } - | { - /** @enum {string} */ - type: "max_file_path_length"; - parameters?: { - /** @description The maximum amount of characters allowed in file paths */ - max_file_path_length: number; - }; - } - | { - /** @enum {string} */ - type: "file_extension_restriction"; - parameters?: { - /** @description The file extensions that are restricted from being pushed to the commit graph. */ - restricted_file_extensions: string[]; - }; - } - | { - /** @enum {string} */ - type: "max_file_size"; - parameters?: { - /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ - max_file_size: number; - }; - } - | components["schemas"]["repository-rule-workflows"]; - /** - * Repository ruleset - * @description A set of rules to apply when specified conditions are met. - */ - "repository-ruleset": { - /** @description The ID of the ruleset */ - id: number; - /** @description The name of the ruleset */ - name: string; - /** - * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. - * @enum {string} - */ - target?: "branch" | "tag" | "push"; - /** - * @description The type of the source of the ruleset - * @enum {string} - */ - source_type?: "Repository" | "Organization"; - /** @description The name of the source */ - source: string; - enforcement: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; - /** - * @description The bypass type of the user making the API request for this ruleset. This field is only returned when - * querying the repository-level endpoint. - * @enum {string} - */ - current_user_can_bypass?: "always" | "pull_requests_only" | "never"; - node_id?: string; - _links?: { - self?: { - /** @description The URL of the ruleset */ - href?: string; - }; - html?: { - /** @description The html URL of the ruleset */ - href?: string; - }; - }; - conditions?: - | ( - | components["schemas"]["repository-ruleset-conditions"] - | components["schemas"]["org-ruleset-conditions"] - ) - | null; - rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ - created_at?: string; - /** Format: date-time */ - updated_at?: string; - }; /** * Rule Suites * @description Response @@ -17956,44 +20307,44 @@ export interface components { * @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 | null; - /** @description The handle for the GitHub user account. */ - actor_name?: string | null; - /** @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"; + evaluation_result?: "pass" | "fail" | "bypass"; + }[]; + /** + * 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 | null; + /** @description The handle for the GitHub user account. */ + actor_name?: string | null; + /** @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`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} + */ + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -18016,8 +20367,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -18126,6 +20477,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -18153,69 +20505,6 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ private_fork: components["schemas"]["simple-repository"] | null; }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; /** * GroupMapping * @description External Groups to be mapped to a team for membership @@ -18998,6 +21287,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -19114,6 +21404,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -19430,6 +21721,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -19437,6 +21729,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -19446,6 +21739,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -19717,6 +22011,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -19768,6 +22063,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -20103,6 +22399,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -20120,6 +22417,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -20175,8 +22473,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -20275,6 +22576,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -20370,8 +22672,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -20589,6 +22897,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -20746,7 +23055,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -20851,7 +23163,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -20882,6 +23194,40 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": + | "pending" + | "error" + | "success" + | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -20976,6 +23322,150 @@ export interface components { /** @description The commit SHA of the repository at the time the CodeQL database was created. */ commit_oid?: string | null; }; + /** + * @description The language targeted by the CodeQL query + * @enum {string} + */ + "code-scanning-variant-analysis-language": + | "cpp" + | "csharp" + | "go" + | "java" + | "javascript" + | "python" + | "ruby" + | "swift"; + /** + * Repository Identifier + * @description Repository Identifier + */ + "code-scanning-variant-analysis-repository": { + /** + * @description A unique identifier of the repository. + * @example 1296269 + */ + id: number; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + /** @description Whether the repository is private. */ + private: boolean; + /** @example 80 */ + stargazers_count: number; + /** + * Format: date-time + * @example 2011-01-26T19:14:43Z + */ + updated_at: string | null; + }; + /** + * @description The new status of the CodeQL variant analysis repository task. + * @enum {string} + */ + "code-scanning-variant-analysis-status": + | "pending" + | "in_progress" + | "succeeded" + | "failed" + | "canceled" + | "timed_out"; + "code-scanning-variant-analysis-skipped-repo-group": { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. */ + repositories: components["schemas"]["code-scanning-variant-analysis-repository"][]; + }; + /** + * Variant Analysis + * @description A run of a CodeQL query against one or more repositories. + */ + "code-scanning-variant-analysis": { + /** @description The ID of the variant analysis. */ + id: number; + controller_repo: components["schemas"]["simple-repository"]; + actor: components["schemas"]["simple-user"]; + query_language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description The download url for the query pack. */ + query_pack_url: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + */ + completed_at?: string | null; + /** @enum {string} */ + status: "in_progress" | "succeeded" | "failed" | "cancelled"; + /** @description The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. */ + actions_workflow_run_id?: number; + /** + * @description The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. + * @enum {string} + */ + failure_reason?: + | "no_repos_queried" + | "actions_workflow_run_failed" + | "internal_error"; + scanned_repositories?: { + repository: components["schemas"]["code-scanning-variant-analysis-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + }[]; + /** @description Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. */ + skipped_repositories?: { + access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + not_found_repos: { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of full repository names that were skipped. This list may not include all repositories that were skipped. */ + repository_full_names: string[]; + }; + no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + }; + }; + "code-scanning-variant-analysis-repo-task": { + repository: components["schemas"]["simple-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + /** @description The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. */ + database_commit_sha?: string; + /** @description The source location prefix to use. This is only available for successful analyses. */ + source_location_prefix?: string; + /** @description The URL of the artifact. This is only available for successful analyses. */ + artifact_url?: string; + }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { /** @@ -20985,6 +23475,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -20996,6 +23487,16 @@ export interface components { | "typescript" | "swift" )[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -21020,6 +23521,16 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -21027,6 +23538,7 @@ export interface components { query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -21077,6 +23589,23 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ errors?: readonly string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -21198,7 +23727,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -21266,6 +23798,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; }; /** * Repository Invitation @@ -21273,6 +23807,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -21309,7 +23844,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -21377,6 +23915,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -21457,7 +23997,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -21747,6 +24290,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -21760,7 +24304,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -21961,6 +24504,23 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; + }; + }; + }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; }; }; }; @@ -21998,6 +24558,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -22110,6 +24671,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -22129,11 +24695,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -22144,7 +24708,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -22181,6 +24745,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -22199,6 +24768,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -22326,7 +24906,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -22358,7 +24941,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -22417,6 +25000,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -22694,6 +25278,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -23076,6 +25661,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -23493,6 +26079,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -23509,14 +26096,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -23662,6 +26255,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -23727,11 +26321,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -23752,12 +26348,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -23979,6 +26575,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -24350,7 +26947,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -24459,359 +27059,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -24879,6 +27136,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -24932,9 +27190,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -25145,6 +27409,8 @@ export interface components { components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-merge-queue"] & + components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & @@ -25166,6 +27432,8 @@ export interface components { | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; @@ -25192,7 +27460,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -25205,11 +27473,25 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -25338,7 +27620,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -25347,7 +27629,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -25413,6 +27695,52 @@ export interface components { | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": + | "false_positive" + | "used_in_tests" + | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -26349,6 +28677,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -26575,6 +28909,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -26620,6 +28955,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -26628,8 +28964,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -26698,6 +29038,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -26739,8 +29084,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -26839,7 +29182,10 @@ export interface components { * @description A codespace. */ "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -27022,7 +29368,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -27062,6 +29411,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -27103,6 +29453,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -27182,6 +29533,45 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + "sigstore-bundle-0": { + mediaType?: string; + verificationMaterial?: { + x509CertificateChain?: { + certificates?: { + rawBytes?: string; + }[]; + }; + tlogEntries?: { + logIndex?: string; + logId?: { + keyId?: string; + }; + kindVersion?: { + kind?: string; + version?: string; + }; + integratedTime?: string; + inclusionPromise?: { + signedEntryTimestamp?: string; + }; + inclusionProof?: string | null; + canonicalizedBody?: string; + }[]; + timestampVerificationData?: string | null; + }; + dsseEnvelope?: { + payload?: string; + payloadType?: string; + signatures?: { + sig?: string; + keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -27314,6 +29704,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -27753,7 +30144,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -27814,75 +30205,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -27907,6 +30229,13 @@ export interface components { | "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -27936,6 +30265,148 @@ export interface components { /** Format: date-time */ updated_at: string; }; + /** + * Push ruleset bypass exemption request data + * @description Push rules that are being requested to be bypassed. + */ + "exemption-request-push-ruleset-bypass": { + /** + * @description The type of request + * @enum {string} + */ + type?: "push_ruleset_bypass"; + /** @description The data pertaining to the push rules that are being requested to be bypassed. */ + data?: { + /** @description The ID of the ruleset for the rules that were violated */ + ruleset_id?: number; + /** @description The name of the ruleset for the rules that were violated */ + ruleset_name?: string; + /** @description The number of violations */ + total_violations?: number; + /** @description The type of rule that was violated */ + rule_type?: string; + }[]; + }; + /** + * Secret scanning push protection exemption request data + * @description Secret scanning push protections that are being requested to be bypassed. + */ + "exemption-request-secret-scanning": { + /** + * @description The type of request + * @enum {string} + */ + type?: "secret_scanning"; + /** @description The data pertaining to the secret scanning push protections that are being requested to be bypassed. */ + data?: { + /** @description The type of secret that was detected */ + secret_type?: string; + /** @description The location data of the secret that was detected */ + locations?: { + /** @description The commit SHA where the secret was detected */ + commit?: string; + /** @description The branch where the secret was detected */ + branch?: string; + /** @description The path of the file where the secret was detected */ + path?: string; + }[]; + }[]; + }; + /** + * Secret Scanning Push Protection Exemption Request Metadata + * @description Metadata for a secret scanning push protection exemption request. + */ + "exemption-request-secret-scanning-metadata": { + /** @description The label for the secret type */ + label?: string; + /** + * @description The reason for the exemption request + * @enum {string} + */ + reason?: "fixed_later" | "false_positive" | "tests"; + }; + /** + * Exemption response + * @description A response to an exemption request by a delegated bypasser. + */ + "exemption-response": { + /** @description The ID of the exemption response. */ + id?: number; + /** @description The ID of the user who reviewed the exemption request. */ + reviewer_id?: number; + /** @description The login of the user who reviewed the exemption request. */ + reviewer_login?: string; + /** + * @description The status of the exemption response. + * @enum {string} + */ + status?: "approved" | "rejected" | "dismissed"; + /** @description The comment the reviewer provided when responding to the exemption request. */ + reviewer_comment?: string | null; + /** + * Format: date-time + * @description The date and time the exemption request was created. + */ + created_at?: string; + }; + /** + * Exemption Request + * @description A request from a user to be exempted from a set of rules. + */ + "exemption-request": { + /** @description The ID of the exemption request. */ + id?: number; + /** @description The number uniquely identifying the exemption request within it's repository. */ + number?: number; + /** @description The ID of the repository the exemption request is for. */ + repository_id?: number; + /** @description The ID of the user who requested the exemption. */ + requester_id?: number; + /** @description The login of the user who requested the exemption. */ + requester_login?: string; + /** + * @description The type of request. + * @enum {string} + */ + request_type?: "push_ruleset_bypass" | "secret_scanning"; + exemption_request_data?: + | components["schemas"]["exemption-request-push-ruleset-bypass"] + | components["schemas"]["exemption-request-secret-scanning"]; + /** + * @description The unique identifier for the request type of the exemption request. For example, a commit SHA. + * @example 827efc6d56897b048c772eb4087f854f46256132 + */ + resource_identifier?: string; + /** + * @description The status of the exemption request. + * @enum {string} + */ + status?: "pending" | "rejected" | "cancelled" | "completed"; + /** @description The comment the requester provided when creating the exemption request. */ + requester_comment?: string | null; + /** @description Metadata about the exemption request. */ + metadata?: + | components["schemas"]["exemption-request-secret-scanning-metadata"] + | null; + /** + * Format: date-time + * @description The date and time the exemption request will expire. + */ + expires_at?: string; + /** + * Format: date-time + * @description The date and time the exemption request was created. + */ + created_at?: string; + /** @description The responses to the exemption request. */ + responses?: components["schemas"]["exemption-response"][] | null; + /** + * Format: uri + * @description The URL to view the exemption request in a browser. + * @example https://github.com/monalisa/smile/exemptions/1 + */ + html_url?: string; + }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -28079,6 +30550,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -28117,6 +30589,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -28186,6 +30659,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28205,6 +30679,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -28264,6 +30739,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28283,6 +30759,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -28328,6 +30805,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -28415,6 +30893,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28434,7 +30913,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -28492,6 +30973,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28511,6 +30993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -28628,6 +31111,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28647,6 +31131,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -28704,6 +31189,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -28740,6 +31226,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -28835,6 +31322,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -28965,6 +31453,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -29072,6 +31561,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -29106,6 +31601,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29125,6 +31621,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -29173,6 +31670,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -29246,6 +31744,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -29282,6 +31781,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -29377,6 +31877,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -29505,6 +32006,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -29612,6 +32114,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -29646,6 +32154,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29665,6 +32174,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -29703,6 +32213,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -29844,6 +32355,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -30283,7 +32795,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -30390,6 +32902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -30443,6 +32956,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -30462,6 +32976,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -30530,6 +33045,10 @@ export interface components { | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -30585,6 +33104,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -30641,6 +33161,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -30757,6 +33278,69 @@ export interface components { */ archived_at: string | null; }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-option": { + id: string; + name: string; + color?: string | null; + description?: string | null; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-setting": { + id: string; + title: string; + duration?: number | null; + start_date?: string | null; + }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + "projects-v2-status-update": { + id: number; + node_id: string; + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @enum {string|null} */ + status?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** + * Format: date + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -30803,7 +33387,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -30896,6 +33480,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -30992,6 +33577,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -31119,7 +33705,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -31212,6 +33801,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -31301,6 +33891,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -31320,6 +33911,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -31459,7 +34051,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -31552,6 +34147,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -31641,6 +34237,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -31660,6 +34257,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -31727,6 +34325,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -31774,6 +34373,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -31982,6 +34582,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -32001,6 +34602,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -32135,6 +34737,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -32154,6 +34757,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -32215,6 +34819,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -32234,6 +34839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -32340,6 +34946,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -32487,6 +35094,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -32627,6 +35235,11 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} @@ -32640,6 +35253,20 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -32647,6 +35274,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -32699,6 +35327,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -32738,6 +35367,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -32775,6 +35405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -32888,7 +35519,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -32898,7 +35529,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -32909,7 +35540,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -32920,7 +35551,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -32944,6 +35575,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync?: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -32957,7 +35602,64 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request cancellation event */ + "webhook-exemption-request-cancelled": { + /** @enum {string} */ + action: "cancelled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request completed event */ + "webhook-exemption-request-completed": { + /** @enum {string} */ + action: "completed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request created event */ + "webhook-exemption-request-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"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption response dismissed event */ + "webhook-exemption-request-response-dismissed": { + /** @enum {string} */ + action: "response_dismissed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + exemption_response: components["schemas"]["exemption-response"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption response submitted event */ + "webhook-exemption-request-response-submitted": { + /** @enum {string} */ + action: "response_submitted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + exemption_response: components["schemas"]["exemption-response"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -32967,7 +35669,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -32985,7 +35687,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -33008,7 +35710,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -33026,7 +35728,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -33112,6 +35814,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -33151,6 +35855,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33344,7 +36049,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -33423,6 +36128,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -33462,6 +36169,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33648,7 +36356,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -33722,6 +36430,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -33761,6 +36471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33946,7 +36657,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -34000,6 +36711,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -34076,7 +36788,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -34130,6 +36842,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -34213,7 +36926,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -34288,9 +37001,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -34308,7 +37021,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -34362,6 +37075,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -34447,7 +37161,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -34540,7 +37254,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -34624,7 +37338,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -34633,7 +37347,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -34700,6 +37414,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34719,13 +37434,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; 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"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -34744,17 +37460,17 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -34766,18 +37482,18 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -34787,7 +37503,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -34806,7 +37522,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -34817,7 +37533,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -34828,7 +37544,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -34839,7 +37555,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -34850,7 +37566,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -34861,7 +37577,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -34872,7 +37588,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -34883,7 +37599,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -34894,7 +37610,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -34905,7 +37621,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -34953,6 +37669,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -35066,6 +37783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35162,7 +37880,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -35202,6 +37920,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -35452,6 +38171,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -35479,7 +38199,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -35491,7 +38211,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -35542,6 +38262,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -35618,6 +38339,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -35730,6 +38452,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -35792,6 +38515,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -35811,7 +38535,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -35862,6 +38586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -35937,6 +38662,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -36049,6 +38775,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -36110,6 +38837,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -36166,11 +38894,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -36220,6 +38949,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -36295,6 +39025,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -36407,6 +39138,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -36469,6 +39201,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -36564,6 +39297,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -36677,6 +39411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36808,6 +39543,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -36926,6 +39662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37019,7 +39756,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -37059,6 +39796,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -37310,6 +40048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -37329,7 +40068,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -37357,7 +40096,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -37368,7 +40107,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -37380,7 +40119,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -37392,7 +40131,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -37409,7 +40148,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -37420,7 +40159,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -37431,7 +40170,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -37450,7 +40189,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -37462,7 +40201,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -37473,7 +40212,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -37484,7 +40223,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -37495,7 +40234,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -37510,7 +40249,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -37520,7 +40259,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -37532,7 +40271,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -37543,7 +40282,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -37554,7 +40293,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -37615,10 +40354,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -37675,7 +40410,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -37751,6 +40489,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -37902,13 +40641,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -37936,7 +40675,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -37948,7 +40687,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -37960,7 +40699,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -37972,7 +40711,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -37996,7 +40735,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -38020,7 +40759,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -38032,7 +40771,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -38072,6 +40811,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -38087,7 +40827,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -38100,7 +40840,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -38178,6 +40918,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38197,6 +40938,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -38246,6 +40988,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38282,6 +41025,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -38377,6 +41121,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38507,6 +41252,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38614,6 +41360,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38648,6 +41400,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38667,6 +41420,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -38706,6 +41460,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -38768,6 +41523,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -38783,7 +41539,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -38837,6 +41593,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38873,6 +41630,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -38968,6 +41726,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39096,6 +41855,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39203,6 +41963,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39237,6 +42003,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39256,6 +42023,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -39295,6 +42063,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -39357,6 +42126,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -39368,11 +42138,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -39427,6 +42198,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39463,6 +42235,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -39558,6 +42331,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39688,6 +42462,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39795,6 +42570,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39829,6 +42610,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39848,6 +42630,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -39887,6 +42670,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -39949,6 +42733,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -39964,7 +42749,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -39979,7 +42764,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -40035,6 +42820,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40071,6 +42857,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40166,6 +42953,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40297,6 +43085,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40404,6 +43193,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40438,6 +43233,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40457,6 +43253,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -40505,6 +43302,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -40516,11 +43314,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -40576,6 +43375,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40707,6 +43507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40836,6 +43637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40943,6 +43745,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40977,6 +43785,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40996,11 +43805,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -41187,6 +43997,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41315,6 +44126,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41422,6 +44234,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41456,6 +44274,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41475,12 +44294,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -41547,6 +44367,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41678,6 +44499,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41809,6 +44631,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41916,6 +44739,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41950,6 +44779,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41969,12 +44799,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -42030,6 +44861,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42161,6 +44993,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42291,6 +45124,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42398,6 +45232,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42432,6 +45272,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42451,12 +45292,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -42512,6 +45354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42548,6 +45391,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -42644,6 +45488,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42774,6 +45619,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42881,6 +45727,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42915,6 +45767,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42934,11 +45787,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -43125,6 +45979,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43254,6 +46109,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43361,6 +46217,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -43395,6 +46257,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43414,12 +46277,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -43474,6 +46338,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43510,6 +46375,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43605,6 +46471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43733,6 +46600,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43840,6 +46708,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -43874,6 +46748,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43893,6 +46768,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -44013,7 +46889,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -44089,6 +46968,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -44189,6 +47069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44225,6 +47106,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44320,6 +47202,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44451,6 +47334,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44558,6 +47442,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44592,6 +47482,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44611,11 +47502,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -44626,7 +47518,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -44813,6 +47705,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44943,6 +47836,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45050,6 +47944,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45084,6 +47984,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45103,11 +48004,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -45162,6 +48064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45198,6 +48101,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45293,6 +48197,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45421,6 +48326,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -45528,6 +48434,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45562,6 +48474,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45581,6 +48494,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -45704,7 +48618,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -45780,6 +48697,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45835,7 +48753,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -45850,7 +48768,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -45862,7 +48780,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -45918,6 +48836,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45954,6 +48873,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -46050,6 +48970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46178,6 +49099,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -46285,6 +49207,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46319,6 +49247,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46338,11 +49267,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -46353,7 +49283,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -46364,7 +49294,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -46375,7 +49305,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -46401,7 +49331,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -46414,7 +49344,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -46453,7 +49383,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -46492,7 +49422,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -46531,7 +49461,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -46544,7 +49474,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -46571,7 +49501,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -46593,7 +49523,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -46604,7 +49534,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -46656,6 +49586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -46709,6 +49640,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -46719,7 +49651,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -46733,7 +49665,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -46816,7 +49748,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -46827,7 +49759,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -46838,7 +49770,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -46849,7 +49781,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -46875,7 +49807,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -46886,7 +49818,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -46897,7 +49829,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -46908,7 +49840,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -46919,7 +49851,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -46930,7 +49862,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -46985,6 +49917,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -46994,7 +49927,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -47006,7 +49939,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -47022,7 +49955,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -47096,6 +50029,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -47135,6 +50069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -47272,6 +50207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -47307,7 +50243,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -47362,6 +50298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -47401,6 +50338,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -47472,6 +50410,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -47508,7 +50447,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -47556,6 +50495,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -47567,15 +50507,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { /** @enum {string} */ action: "approved"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -47583,8 +50524,9 @@ export interface components { /** @enum {string} */ action: "cancelled"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -47592,9 +50534,10 @@ export interface components { /** @enum {string} */ action: "created"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ "webhook-personal-access-token-request-denied": { @@ -47602,7 +50545,8 @@ export interface components { action: "denied"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -47649,7 +50593,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -47672,7 +50616,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -47683,7 +50627,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -47740,6 +50684,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -47753,7 +50698,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -47769,7 +50714,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -47830,6 +50775,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -47875,7 +50821,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -47886,7 +50832,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -47897,7 +50843,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -47908,7 +50854,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -47924,7 +50870,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -47935,7 +50881,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -47946,7 +50892,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -47957,7 +50903,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -47979,7 +50925,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -47990,7 +50936,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -47999,7 +50945,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -48008,7 +50954,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -48017,7 +50963,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -48044,7 +50990,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -48054,7 +51000,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -48069,7 +51015,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -48078,7 +51024,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -48087,18 +51033,36 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { field_value: { field_node_id?: string; field_type?: string; + field_name?: string; + project_number?: number; + from?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; + to?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; }; }, { @@ -48112,7 +51076,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -48127,7 +51091,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -48137,7 +51101,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -48146,7 +51110,70 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Created Event */ + "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Deleted Event */ + "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Edited Event */ + "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; + }; + status?: { + /** @enum {string|null} */ + from?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** @enum {string|null} */ + to?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + }; + start_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + target_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -48154,7 +51181,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -48253,6 +51280,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48289,6 +51317,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48349,6 +51378,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48476,7 +51506,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48569,6 +51602,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48632,7 +51666,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48661,6 +51695,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48680,6 +51715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -48819,7 +51855,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48912,6 +51951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48975,7 +52015,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49004,6 +52044,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49023,6 +52064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -49090,6 +52132,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -49137,6 +52180,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49205,6 +52249,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -49345,6 +52390,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49364,10 +52410,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -49465,6 +52512,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49561,6 +52609,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -49688,7 +52737,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49781,6 +52833,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49844,7 +52897,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49873,6 +52926,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49892,6 +52946,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -50031,7 +53086,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50124,6 +53182,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50187,7 +53246,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50216,6 +53275,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50235,6 +53295,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50302,6 +53363,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -50349,6 +53411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50417,6 +53480,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50557,6 +53621,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50576,11 +53641,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -50678,6 +53744,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50774,6 +53841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -50901,7 +53969,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50994,6 +54065,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51057,7 +54129,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51086,6 +54158,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51105,6 +54178,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51337,6 +54411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51400,7 +54475,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51429,6 +54504,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51448,6 +54524,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -51515,6 +54592,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -51562,6 +54640,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51630,6 +54709,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -51770,6 +54850,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51789,11 +54870,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -51805,7 +54887,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -51817,7 +54899,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -51829,7 +54911,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -51927,6 +55009,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52023,6 +55106,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52150,7 +55234,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52243,6 +55330,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52306,7 +55394,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52335,6 +55423,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52354,6 +55443,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52493,7 +55583,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52586,6 +55679,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52649,7 +55743,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52678,6 +55772,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52697,6 +55792,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -52764,6 +55860,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -52811,6 +55908,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -52879,6 +55977,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53019,6 +56118,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53038,11 +56138,25 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: + | "UNKNOWN_REMOVAL_REASON" + | "MANUAL" + | "MERGE" + | "MERGE_CONFLICT" + | "CI_FAILURE" + | "CI_TIMEOUT" + | "ALREADY_MERGED" + | "QUEUE_CLEARED" + | "ROLL_BACK" + | "BRANCH_PROTECTIONS" + | "GIT_TREE_INVALID" + | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -53073,7 +56187,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -53171,6 +56285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53267,6 +56382,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53394,7 +56510,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53487,6 +56606,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53550,7 +56670,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53579,6 +56699,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53598,6 +56719,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53737,7 +56859,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53830,6 +56955,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53893,7 +57019,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53922,6 +57048,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53941,6 +57068,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54008,6 +57136,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54055,6 +57184,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54123,6 +57253,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -54263,6 +57394,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54282,10 +57414,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -54384,6 +57517,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54480,6 +57614,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54607,7 +57742,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54700,6 +57838,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54763,7 +57902,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54792,6 +57931,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54811,6 +57951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -54950,7 +58091,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55043,6 +58187,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55106,7 +58251,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55135,6 +58280,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55154,6 +58300,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55221,6 +58368,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -55268,6 +58416,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55336,6 +58485,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -55476,6 +58626,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55495,10 +58646,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -55596,6 +58748,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55692,6 +58845,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55819,7 +58973,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55912,6 +59069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55975,7 +59133,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56004,6 +59162,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56023,6 +59182,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56162,7 +59322,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56255,6 +59418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56318,7 +59482,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56347,6 +59511,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56366,6 +59531,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56433,6 +59599,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -56480,6 +59647,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56548,6 +59716,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56688,6 +59857,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56707,10 +59877,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -56722,7 +59893,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -56734,7 +59905,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -56746,7 +59917,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -56758,7 +59929,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -56896,6 +60067,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56915,6 +60087,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -57006,6 +60179,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57102,6 +60276,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57229,7 +60404,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57322,6 +60500,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57385,7 +60564,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57414,6 +60593,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57433,6 +60613,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -57565,7 +60746,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57658,6 +60842,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57721,7 +60906,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57750,6 +60935,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57769,6 +60955,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57840,6 +61027,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57906,6 +61094,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -58040,6 +61229,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58059,10 +61249,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -58158,6 +61349,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58254,6 +61446,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -58381,7 +61574,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58474,6 +61670,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58537,7 +61734,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58566,6 +61763,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58585,6 +61783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58717,7 +61916,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58810,6 +62012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58873,7 +62076,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58902,6 +62105,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58921,6 +62125,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58992,6 +62197,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59058,6 +62264,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -59192,6 +62399,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59211,10 +62419,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -59311,6 +62520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59347,6 +62557,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -59407,6 +62618,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59534,7 +62746,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59627,6 +62842,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59690,7 +62906,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -59719,6 +62935,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59738,6 +62955,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59870,7 +63088,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59963,6 +63184,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60026,7 +63248,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60055,6 +63277,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60074,6 +63297,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60145,6 +63369,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60211,6 +63436,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -60345,6 +63571,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60362,12 +63589,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -60463,6 +63691,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60559,6 +63788,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60686,7 +63916,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60779,6 +64012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60842,7 +64076,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60871,6 +64105,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60890,6 +64125,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61022,7 +64258,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61115,6 +64354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61178,7 +64418,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61207,6 +64447,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61226,6 +64467,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61297,6 +64539,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61363,6 +64606,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61497,6 +64741,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61516,6 +64761,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -61579,6 +64825,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61598,9 +64845,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -61702,6 +64950,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61798,6 +65047,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61920,7 +65170,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61996,6 +65249,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62061,6 +65315,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62080,6 +65335,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62207,7 +65463,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62283,6 +65542,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62348,6 +65608,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62367,6 +65628,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62438,6 +65700,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62504,6 +65767,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -62638,6 +65902,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62657,11 +65922,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -62762,6 +66028,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -62798,6 +66065,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -62858,6 +66126,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62985,7 +66254,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63078,6 +66350,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63134,7 +66407,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63163,6 +66436,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63182,6 +66456,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63321,7 +66596,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63414,6 +66692,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63477,7 +66756,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63506,6 +66785,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63525,6 +66805,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63592,6 +66873,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -63639,6 +66921,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63707,6 +66990,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -63847,6 +67131,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63866,6 +67151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -63905,8 +67191,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -64004,6 +67291,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64040,6 +67328,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -64100,6 +67389,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64227,7 +67517,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64320,6 +67613,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64383,7 +67677,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64412,6 +67706,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64431,6 +67726,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64570,7 +67866,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64663,6 +67962,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64726,7 +68026,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64755,6 +68055,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64774,6 +68075,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -64841,6 +68143,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -64888,6 +68191,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -64956,6 +68260,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -65096,6 +68401,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65115,6 +68421,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -65173,7 +68480,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -65276,6 +68583,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65312,6 +68620,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -65372,6 +68681,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65499,7 +68809,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65592,6 +68905,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65655,7 +68969,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65684,6 +68998,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65703,6 +69018,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -65842,7 +69158,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65935,6 +69254,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65998,7 +69318,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66027,6 +69347,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66046,6 +69367,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66113,6 +69435,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -66160,6 +69483,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66228,6 +69552,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -66368,6 +69693,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66387,6 +69713,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -66426,8 +69753,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -66525,6 +69853,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66561,6 +69890,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -66621,6 +69951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66748,7 +70079,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66841,6 +70175,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66904,7 +70239,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66933,6 +70268,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66952,6 +70288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67091,7 +70428,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67184,6 +70524,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67247,7 +70588,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -67276,6 +70617,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67295,6 +70637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67362,6 +70705,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -67409,6 +70753,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67477,6 +70822,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67617,6 +70963,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67636,6 +70983,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -67694,7 +71042,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -67792,6 +71140,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67888,6 +71237,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68015,7 +71365,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68108,6 +71461,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68171,7 +71525,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68200,6 +71554,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68219,6 +71574,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68351,7 +71707,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68444,6 +71803,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68507,7 +71867,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68536,6 +71896,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68555,6 +71916,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68626,6 +71988,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68692,6 +72055,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -68826,6 +72190,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68845,11 +72210,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -68945,6 +72311,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69041,6 +72408,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69168,7 +72536,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69244,6 +72615,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69311,6 +72683,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69330,6 +72703,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -69462,7 +72836,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69538,6 +72915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69605,6 +72983,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69624,6 +73003,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69695,6 +73075,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -69761,6 +73142,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -69895,6 +73277,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69914,10 +73297,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -70047,6 +73431,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70066,6 +73451,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -70165,6 +73551,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70261,6 +73648,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70388,7 +73776,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70464,6 +73855,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70531,6 +73923,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70550,6 +73943,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70682,7 +74076,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70758,6 +74155,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70825,6 +74223,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70844,6 +74243,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -70915,6 +74315,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70981,6 +74382,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -71115,6 +74517,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71134,10 +74537,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -71267,6 +74671,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71286,6 +74691,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -71389,6 +74795,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -71485,6 +74892,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -71612,7 +75020,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71705,6 +75116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71768,7 +75180,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -71797,6 +75209,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71816,6 +75229,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -71955,7 +75369,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72041,6 +75458,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72104,7 +75522,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -72133,6 +75551,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72152,6 +75571,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72219,6 +75639,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -72266,6 +75687,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72334,6 +75756,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -72474,6 +75897,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72493,10 +75917,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -72595,6 +76020,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72691,6 +76117,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72818,7 +76245,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72911,6 +76341,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72974,7 +76405,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73003,6 +76434,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73022,6 +76454,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73161,7 +76594,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73254,6 +76690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73317,7 +76754,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73346,6 +76783,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73365,6 +76803,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73432,6 +76871,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -73479,6 +76919,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73547,6 +76988,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -73687,6 +77129,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73706,10 +77149,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -73808,6 +77252,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -73904,6 +77349,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -74031,7 +77477,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74124,6 +77573,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74187,7 +77637,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -74216,6 +77666,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74235,6 +77686,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -74374,7 +77826,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74460,6 +77915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74523,7 +77979,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -74552,6 +78008,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74571,6 +78028,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -74638,6 +78096,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -74685,6 +78144,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -74753,6 +78213,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -74893,6 +78354,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -74912,10 +78374,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -75013,6 +78476,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -75109,6 +78573,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -75236,7 +78701,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75329,6 +78797,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -75392,7 +78861,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -75421,6 +78890,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75440,6 +78910,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -75579,7 +79050,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -75672,6 +79146,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -75735,7 +79210,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -75764,6 +79239,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75783,6 +79259,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -75850,6 +79327,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -75897,6 +79375,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -75965,6 +79444,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -76105,6 +79585,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -76124,10 +79605,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -76385,7 +79867,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76461,6 +79946,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76510,7 +79996,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -76545,6 +80031,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -76567,6 +80054,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -76685,6 +80173,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -76715,7 +80204,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -76750,6 +80239,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -76772,6 +80262,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -76824,6 +80315,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -76848,7 +80340,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -76859,7 +80351,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -76870,7 +80362,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -76895,7 +80387,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -77007,6 +80499,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -77055,7 +80548,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -77066,7 +80559,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -77077,7 +80570,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -77088,7 +80581,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -77099,7 +80592,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -77110,7 +80603,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -77120,7 +80613,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -77130,7 +80623,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -77140,7 +80633,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -77155,7 +80648,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -77179,7 +80672,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -77187,7 +80680,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -77199,7 +80692,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -77209,7 +80702,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -77226,7 +80719,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -77237,7 +80730,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -77248,7 +80741,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -77306,7 +80799,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -77357,6 +80850,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -77376,6 +80870,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -77384,7 +80879,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -77394,7 +80889,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -77405,7 +80900,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -77458,6 +80953,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -77478,7 +80974,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -77489,7 +80985,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -77561,7 +81057,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -77572,7 +81068,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -77583,13 +81079,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + 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"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -77599,7 +81106,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -77610,29 +81117,61 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - action: "revoked"; + action: "validated"; alert: components["schemas"]["secret-scanning-alert-webhook"]; 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"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert validated event */ - "webhook-secret-scanning-alert-validated": { + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { /** @enum {string} */ - action: "validated"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: + | "repository" + | "organization" + | "enterprise" + | null; + repository?: components["schemas"]["repository-webhooks"]; 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"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -77643,7 +81182,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -77654,7 +81193,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -77670,6 +81209,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -77701,7 +81241,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -77714,7 +81254,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -77724,7 +81264,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -77735,7 +81275,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -77752,7 +81292,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -77764,7 +81304,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -77777,7 +81317,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -77789,7 +81329,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -77800,7 +81340,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -77812,7 +81352,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -77927,6 +81467,7 @@ export interface components { | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -77991,7 +81532,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -78003,13 +81544,77 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** team_add event */ "webhook-team-add": { 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"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -78135,7 +81740,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78211,6 +81819,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78258,7 +81867,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -78384,7 +81993,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78460,6 +82072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78507,7 +82120,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -78633,7 +82246,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78709,6 +82325,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -78756,7 +82373,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -78913,7 +82530,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -78989,6 +82609,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79036,7 +82657,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -79162,7 +82783,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -79238,6 +82862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -79285,7 +82910,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -79296,7 +82921,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -79308,7 +82933,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -79319,7 +82944,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -79424,7 +83049,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -79522,7 +83147,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -79576,7 +83201,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -79635,7 +83260,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -79675,6 +83300,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -79694,6 +83320,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -79834,6 +83461,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -80008,6 +83636,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -80082,6 +83711,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -80105,7 +83735,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -80569,7 +84199,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -80609,6 +84239,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -80769,6 +84400,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -80943,6 +84575,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -81017,6 +84650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -81115,12 +84749,56 @@ export interface components { }; }; }; + /** @description Conflict */ + conflict: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description A header with no content is returned. */ + no_content: { + content: never; + }; /** @description Internal Error */ internal_error: { content: { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response when getting cost centers */ + get_all_cost_centers: { + content: { + "application/json": components["schemas"]["get-all-cost-centers"]; + }; + }; + /** @description Response when adding resources to a cost center */ + add_resource_to_cost_center: { + content: { + "application/json": { + message?: string; + }; + }; + }; + /** @description Response when removing resources from a cost center */ + remove_resource_from_cost_center: { + content: { + "application/json": { + message?: string; + }; + }; + }; + /** @description Response when getting a billing usage report */ + billing_usage_report: { + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; /** @description Forbidden Gist */ forbidden_gist: { content: { @@ -81141,20 +84819,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-report"]; }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { content: never; }; - /** @description A header with no content is returned. */ - no_content: { - content: never; - }; /** @description Gone */ gone: { content: { @@ -81179,6 +84853,18 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { content: never; @@ -81325,10 +85011,14 @@ export interface components { * The default is `desc`. */ "audit-log-order"?: "desc" | "asc"; + /** @description The ID of the audit log stream configuration. */ + "audit-log-stream-id": number; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ "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 code security configuration. */ + "configuration-id": number; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * @@ -81369,13 +85059,11 @@ export interface components { * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ "pagination-last"?: number; + /** @description The custom property name */ + "custom-property-name": string; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution"?: string; @@ -81383,13 +85071,32 @@ export interface components { "secret-scanning-alert-sort"?: "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity"?: string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked"?: boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo"?: boolean; + /** @description The ID corresponding to the cost center. */ + "cost-center": string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year"?: number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month"?: number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day"?: number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour"?: number; + /** @description The slug of the enterprise team name. */ + "enterprise-team-slug": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" | "advanced_security_user_namespace" | "dependabot_alerts" | "secret_scanning" - | "secret_scanning_push_protection"; + | "secret_scanning_push_protection" + | "secret_scanning_non_provider_patterns"; /** * @description The action to take. * @@ -81439,12 +85146,76 @@ export interface components { "audit-log-phrase"?: string; /** @description The handle for the GitHub user account. */ username: string; + /** @description The name of the repository to filter on. */ + "repository-name-in-query"?: string; + /** @description Filter bypass requests by the handle of the GitHub user who reviewed the bypass request. */ + "bypass-reviewer-name"?: string; + /** @description Filter bypass requests by the handle of the GitHub user who requested the bypass. */ + "bypass-requester-name"?: string; + /** + * @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 status of the bypass request to filter on. When specified, only requests with this status will be returned. */ + "bypass-request-status"?: + | "completed" + | "cancelled" + | "expired" + | "denied" + | "open" + | "all"; /** @description The unique identifier of the role. */ "role-id": number; /** @description The unique identifier of the group. */ "group-id": number; + /** @description The number of results per page for the "members" array (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-per-page"?: number; + /** @description The page number of the "members" array results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-page"?: number; /** @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 type of the actor */ + "api-insights-actor-type": + | "installation" + | "classic_pat" + | "fine_grained_pat" + | "oauth_app" + | "github_app_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-max-timestamp"?: string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "http_method" + | "api_route" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring"?: string; + /** @description The property to sort the results by. */ + "api-insights-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "subject_name" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring"?: string; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring"?: string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -81453,8 +85224,6 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * @@ -81488,16 +85257,14 @@ 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). + * @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. */ - "time-period"?: "hour" | "day" | "week" | "month"; + "ruleset-targets"?: string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ + "ref-in-query"?: string; /** @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. */ @@ -81610,6 +85377,8 @@ export interface components { status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ "git-ref"?: components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias"?: number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -81658,8 +85427,6 @@ 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. */ @@ -81786,13 +85553,23 @@ export interface operations { * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** + * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; direction?: components["parameters"]["direction"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; }; responses: { @@ -81927,7 +85704,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -82495,8 +86271,6 @@ export interface operations { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/create-installation-access-token": { @@ -82576,7 +86350,7 @@ export interface operations { }; /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ "apps/delete-authorization": { @@ -82603,7 +86377,7 @@ export interface operations { }; /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -82632,7 +86406,7 @@ export interface operations { }; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -82658,7 +86432,7 @@ export interface operations { }; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -82691,10 +86465,6 @@ export interface operations { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ "apps/scope-token": { parameters: { @@ -82748,7 +86518,8 @@ export interface operations { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ "apps/get-by-slug": { parameters: { @@ -84004,7 +87775,7 @@ export interface operations { * Get the audit log for an enterprise * @description Gets the audit log for an enterprise. * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." * * The authenticated user must be an enterprise admin to use this endpoint. * @@ -84034,6 +87805,198 @@ export interface operations { }; }; }; + /** + * Get the audit log stream key for encrypting secrets + * @description Retrieves the audit log streaming public key for encrypting secrets. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + "enterprise-admin/get-audit-log-stream-key": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description The stream key for the audit log streaming configuration was retrieved successfully. */ + 200: { + content: { + "application/json": components["schemas"]["audit-log-stream-key"]; + }; + }; + }; + }; + /** + * List audit log stream configurations for an enterprise + * @description Lists the configured audit log streaming configurations for an enterprise. + * This only lists configured streams for supported providers. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + "enterprise-admin/get-audit-log-streams": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["get-audit-log-stream-configs"]; + }; + }; + }; + }; + /** + * Create an audit log streaming configuration for an enterprise + * @description Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + "enterprise-admin/create-audit-log-stream": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description This setting pauses or resumes a stream. */ + enabled: boolean; + /** + * @description The audit log streaming provider. The name is case sensitive. + * @enum {string} + */ + stream_type: + | "Azure Blob Storage" + | "Azure Event Hubs" + | "Amazon S3" + | "Splunk" + | "HTTPS Event Collector" + | "Google Cloud Storage" + | "Datadog"; + vendor_specific: + | components["schemas"]["azure-blob-config"] + | components["schemas"]["azure-hub-config"] + | components["schemas"]["amazon-s3-oidc-config"] + | components["schemas"]["amazon-s3-access-keys-config"] + | components["schemas"]["splunk-config"] + | components["schemas"]["google-cloud-config"] + | components["schemas"]["datadog-config"]; + }; + }; + }; + responses: { + /** @description The audit log stream configuration was created successfully. */ + 200: { + content: { + "application/json": components["schemas"]["get-audit-log-stream-config"]; + }; + }; + }; + }; + /** + * List one audit log streaming configuration via a stream ID + * @description Lists one audit log stream configuration via a stream ID. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + "enterprise-admin/get-one-audit-log-stream": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + stream_id: components["parameters"]["audit-log-stream-id"]; + }; + }; + responses: { + /** @description Lists one audit log stream configuration via stream ID. */ + 200: { + content: { + "application/json": components["schemas"]["get-audit-log-stream-config"]; + }; + }; + }; + }; + /** + * Update an existing audit log stream configuration + * @description Updates an existing audit log stream configuration for an enterprise. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + "enterprise-admin/update-audit-log-stream": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + stream_id: components["parameters"]["audit-log-stream-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description This setting pauses or resumes a stream. */ + enabled: boolean; + /** + * @description The audit log streaming provider. The name is case sensitive. + * @enum {string} + */ + stream_type: + | "Azure Blob Storage" + | "Azure Event Hubs" + | "Amazon S3" + | "Splunk" + | "HTTPS Event Collector" + | "Google Cloud Storage" + | "Datadog"; + vendor_specific: + | components["schemas"]["azure-blob-config"] + | components["schemas"]["azure-hub-config"] + | components["schemas"]["amazon-s3-oidc-config"] + | components["schemas"]["amazon-s3-access-keys-config"] + | components["schemas"]["splunk-config"] + | components["schemas"]["google-cloud-config"] + | components["schemas"]["datadog-config"]; + }; + }; + }; + responses: { + /** @description Successful update */ + 200: { + content: { + "application/json": components["schemas"]["get-audit-log-stream-config"]; + }; + }; + /** @description Validation error */ + 422: { + content: { + "application/json": { + errors?: string[]; + }; + }; + }; + }; + }; + /** + * Delete an audit log streaming configuration for an enterprise + * @description Deletes an existing audit log stream configuration for an enterprise. + * + * When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "[Encrypting secrets for the REST API](/rest/guides/encrypting-secrets-for-the-rest-api)." + */ + "enterprise-admin/delete-audit-log-stream": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + stream_id: components["parameters"]["audit-log-stream-id"]; + }; + }; + responses: { + /** @description The audit log stream configuration was deleted successfully. */ + 204: { + content: never; + }; + }; + }; /** * List code scanning alerts for an enterprise * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -84076,13 +88039,483 @@ export interface operations { }; }; /** - * Get code security and analysis features for an enterprise - * @description Gets code security and analysis settings for the specified enterprise. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-configurations-for-enterprise": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/create-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-default-configurations-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + }; + }; + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-single-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/delete-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ + "code-security/update-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/attach-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-repositories-for-enterprise-configuration": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get code security and analysis features for an enterprise + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to fetch code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + * + * Gets code security and analysis settings for the specified enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ "secret-scanning/get-security-analysis-settings-for-enterprise": { parameters: { path: { @@ -84101,7 +88534,11 @@ export interface operations { }; /** * Update code security and analysis features for an enterprise - * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to update code security and analysis settings for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + * + * Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. * * The authenticated user must be an administrator of the enterprise to use this endpoint. * @@ -84131,8 +88568,10 @@ export interface operations { * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; - /** @description Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise. */ - secret_scanning_validity_checks_enabled?: boolean | null; + /** @description Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise. */ + secret_scanning_non_provider_patterns_enabled_for_new_repositories?: + | boolean + | null; }; }; }; @@ -84178,22 +88617,114 @@ export interface operations { }; }; }; + /** + * List all Copilot seat assignments for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * + * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. + * + * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have + * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, + * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * + * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * + * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + "copilot/list-copilot-seats-for-enterprise": { + parameters: { + query?: { + page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ + total_seats?: number; + seats?: components["schemas"]["copilot-seat-details"][]; + }; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get Copilot metrics for an enterprise + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-enterprise": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * + * Only owners and billing managers can view Copilot usage metrics for the enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-enterprise": { parameters: { @@ -84289,6 +88820,277 @@ export interface operations { }; }; }; + /** + * Get custom properties for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all custom properties defined for an enterprise. + * Enterprise members can read these properties. + */ + "enterprise-admin/get-enterprise-custom-properties": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update custom properties for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates new or updates existing custom properties defined for an enterprise in a batch. + * + * To use this endpoint, the authenticated user must be an administrator for the enterprise. + */ + "enterprise-admin/create-or-update-enterprise-custom-properties": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The array of custom properties to create or update. */ + properties: components["schemas"]["custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get a custom property for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a custom property that is defined for an enterprise. + * Enterprise members can read these properties. + */ + "enterprise-admin/get-enterprise-custom-property": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update a custom property for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a new or updates an existing custom property that is defined for an enterprise. + * + * To use this endpoint, the authenticated user must be an administrator for the enterprise. + */ + "enterprise-admin/create-or-update-enterprise-custom-property": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["custom-property-set-payload"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Remove a custom property for an enterprise + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Remove a custom property that is defined for an enterprise. + * + * To use this endpoint, the authenticated user must be an administrator for the enterprise. + */ + "enterprise-admin/remove-enterprise-custom-property": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create an enterprise repository ruleset + * @description Create a repository ruleset for an enterprise. + */ + "repos/create-enterprise-ruleset": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + /** @description Request body */ + requestBody: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name: string; + /** + * @description The target of the ruleset + * @default branch + * @enum {string} + */ + target?: "branch" | "tag" | "push" | "repository"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["enterprise-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get an enterprise repository ruleset + * @description Get a repository ruleset for an enterprise. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + "repos/get-enterprise-ruleset": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Update an enterprise repository ruleset + * @description Update a ruleset for an enterprise. + */ + "repos/update-enterprise-ruleset": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + /** @description Request body */ + requestBody?: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name?: string; + /** + * @description The target of the ruleset + * @enum {string} + */ + target?: "branch" | "tag" | "push" | "repository"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["enterprise-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Delete an enterprise repository ruleset + * @description Delete a ruleset for an enterprise. + */ + "repos/delete-enterprise-ruleset": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. @@ -84306,6 +89108,8 @@ export interface operations { before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { enterprise: components["parameters"]["enterprise"]; @@ -84375,6 +89179,83 @@ export interface operations { }; }; }; + /** + * Get all cost centers for an enterprise + * @description Gets a list of all the cost centers for an enterprise. + */ + "billing/get-all-cost-centers": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + 200: components["responses"]["get_all_cost_centers"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Add users to a cost center + * @description Adds users to a cost center. + * + * The usage for the users will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. + */ + "billing/add-resource-to-cost-center": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + cost_center_id: components["parameters"]["cost-center"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the users to add to the cost center. */ + users: string[]; + }; + }; + }; + responses: { + 200: components["responses"]["add_resource_to_cost_center"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 409: components["responses"]["conflict"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Remove users from a cost center + * @description Remove users from a cost center. + * + * The usage for the users will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. + */ + "billing/remove-resource-from-cost-center": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + cost_center_id: components["parameters"]["cost-center"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the users to remove from the cost center. */ + users: string[]; + }; + }; + }; + responses: { + 200: components["responses"]["remove_resource_from_cost_center"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get GitHub Packages billing for an enterprise * @description Gets the free and paid storage used for GitHub Packages in gigabytes. @@ -84421,9 +89302,138 @@ export interface operations { }; }; }; + /** + * Get billing usage report for an enterprise + * @description Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center. + * + * **Note:** This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform for enterprises](https://docs.github.com/enterprise-cloud@latest//billing/using-the-enhanced-billing-platform-for-enterprises/about-the-enhanced-billing-platform-for-enterprises#how-do-i-know-if-i-can-access-the-enhanced-billing-platform)." + */ + "billing/get-github-billing-usage-report-ghe": { + parameters: { + query?: { + year?: components["parameters"]["billing-usage-report-year"]; + month?: components["parameters"]["billing-usage-report-month"]; + day?: components["parameters"]["billing-usage-report-day"]; + hour?: components["parameters"]["billing-usage-report-hour"]; + /** @description The ID corresponding to a cost center. The default value is no cost center. */ + cost_center_id?: string; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + 200: components["responses"]["billing_usage_report"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get Copilot metrics for an enterprise team + * @description > [!NOTE] + * > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + * + * Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + team_slug: components["parameters"]["enterprise-team-slug"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get a summary of Copilot usage for an enterprise team + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/enterprise-cloud@latest//admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." + * + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + * See the response schema tab for detailed metrics definitions. + * + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * + * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + */ + "copilot/usage-metrics-for-enterprise-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Enable or disable a security feature - * @description Enables or disables the specified security feature for all repositories in an enterprise. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for an enterprise is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-09-27-upcoming-replacement-of-enterprise-code-security-enablement-ui-and-apis). + * + * Enables or disables the specified security feature for all repositories in an enterprise. * * The authenticated user must be an administrator of the enterprise to use this endpoint. * @@ -84451,7 +89461,8 @@ export interface operations { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-public-events": { parameters: { @@ -84486,7 +89497,8 @@ export interface operations { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -84528,7 +89540,8 @@ export interface operations { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ "gists/create": { requestBody: { @@ -85139,10 +90152,8 @@ export interface operations { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -85299,7 +90310,7 @@ export interface operations { * Get a subscription plan for an account * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account": { parameters: { @@ -85327,7 +90338,7 @@ export interface operations { * List plans * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans": { parameters: { @@ -85354,7 +90365,7 @@ export interface operations { * List accounts for a plan * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan": { parameters: { @@ -85388,7 +90399,7 @@ export interface operations { * Get a subscription plan for an account (stubbed) * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account-stubbed": { parameters: { @@ -85414,7 +90425,7 @@ export interface operations { * List plans (stubbed) * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans-stubbed": { parameters: { @@ -85440,7 +90451,7 @@ export interface operations { * List accounts for a plan (stubbed) * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan-stubbed": { parameters: { @@ -85476,7 +90487,8 @@ export interface operations { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ "meta/get": { responses: { @@ -85489,7 +90501,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-repo-network": { parameters: { query?: { @@ -85745,7 +90761,8 @@ export interface operations { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ "orgs/list": { parameters: { @@ -85769,10 +90786,10 @@ export interface operations { }; }; /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -85803,6 +90820,32 @@ export interface operations { }; }; }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/enterprise-cloud@latest//billing/using-the-new-billing-platform)." + */ + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + year?: components["parameters"]["billing-usage-report-year"]; + month?: components["parameters"]["billing-usage-report-month"]; + day?: components["parameters"]["billing-usage-report-day"]; + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get an organization * @description Gets information about an organization. @@ -85811,17 +90854,6 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. @@ -85866,20 +90898,13 @@ export interface operations { }; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Cloud will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -85931,7 +90956,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -85963,7 +90988,10 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -85971,7 +90999,10 @@ export interface operations { */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -85979,7 +91010,10 @@ export interface operations { */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -85987,7 +91021,10 @@ export interface operations { */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -85995,7 +91032,10 @@ export interface operations { */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -86003,7 +91043,10 @@ export interface operations { */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -86014,8 +91057,15 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link?: string; - /** @description Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. */ + /** + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. + * + * Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. + */ secret_scanning_validity_checks_enabled?: boolean; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -87776,6 +92826,54 @@ export interface operations { }; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "orgs/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * Get the audit log for an organization * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." @@ -87784,7 +92882,7 @@ export interface operations { * * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -87897,6 +92995,36 @@ export interface operations { }; }; }; + /** + * List push rule bypass requests within an organization + * @description Lists the requests made by users of a repository to bypass push protection rules within an organization. + */ + "orgs/list-push-bypass-requests": { + parameters: { + query?: { + repository_name?: components["parameters"]["repository-name-in-query"]; + reviewer?: components["parameters"]["bypass-reviewer-name"]; + requester?: components["parameters"]["bypass-requester-name"]; + time_period?: components["parameters"]["time-period"]; + request_status?: components["parameters"]["bypass-request-status"]; + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["push-rule-bypass-request"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." @@ -87940,6 +93068,546 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/create-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-default-configurations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/detach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/delete-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/update-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + content: never; + }; + }; + }; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/attach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: + | "all" + | "all_without_configurations" + | "public" + | "private_or_internal" + | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/set-configuration-as-default": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-repositories-for-configuration": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; + }; + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. @@ -88362,15 +94030,16 @@ export interface operations { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. + * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-organization-details": { parameters: { @@ -88397,13 +94066,16 @@ export interface operations { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/list-copilot-seats": { parameters: { @@ -88438,18 +94110,19 @@ export interface operations { }; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/add-copilot-seats-for-teams": { parameters: { @@ -88485,21 +94158,118 @@ export interface operations { }; }; /** - * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Remove teams from the Copilot subscription for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * + * Only organization owners can cancel Copilot seats for their organization members. + * + * The response contains the total number of seats set to "pending cancellation". + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + */ + "copilot/cancel-copilot-seat-assignment-for-teams": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The names of teams from which to revoke access to GitHub Copilot. */ + selected_teams: string[]; + }; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": { + seats_cancelled: number; + }; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { + content: never; + }; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Add users to the Copilot subscription for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + * + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + * + * The response contains the total number of new seats that were created and existing seats that were refreshed. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + */ + "copilot/add-copilot-seats-for-users": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ + selected_usernames: string[]; + }; + }; + }; + responses: { + /** @description OK */ + 201: { + content: { + "application/json": { + seats_created: number; + }; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { + content: never; + }; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Remove users from the Copilot subscription for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * Only organization owners can cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ - "copilot/cancel-copilot-seat-assignment-for-teams": { + "copilot/cancel-copilot-seat-assignment-for-users": { parameters: { path: { org: components["parameters"]["org"]; @@ -88508,8 +94278,8 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The names of teams from which to revoke access to GitHub Copilot. */ - selected_teams: string[]; + /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ + selected_usernames: string[]; }; }; }; @@ -88525,7 +94295,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ 422: { content: never; }; @@ -88533,117 +94303,65 @@ export interface operations { }; }; /** - * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. * - * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ - "copilot/add-copilot-seats-for-users": { + "copilot/copilot-metrics-for-organization": { parameters: { - path: { - org: components["parameters"]["org"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ - selected_usernames: string[]; - }; - }; - }; - responses: { - /** @description OK */ - 201: { - content: { - "application/json": { - seats_created: number; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { - content: never; + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; }; - 500: components["responses"]["internal_error"]; - }; - }; - /** - * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ - "copilot/cancel-copilot-seat-assignment-for-users": { - parameters: { path: { org: components["parameters"]["org"]; }; }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ - selected_usernames: string[]; - }; - }; - }; responses: { - /** @description OK */ + /** @description Response */ 200: { content: { - "application/json": { - seats_cancelled: number; - }; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ - 422: { - content: never; - }; + 422: components["responses"]["usage_metrics_api_disabled"]; 500: components["responses"]["internal_error"]; }; }; /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. + * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-org": { parameters: { @@ -88866,10 +94584,10 @@ export interface operations { }; }; /** - * Deprecated - Create a custom role + * Closing down - Create a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. * * Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -88900,10 +94618,10 @@ export interface operations { }; }; /** - * Deprecated - Get a custom role + * Closing down - Get a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. * * Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -88929,10 +94647,10 @@ export interface operations { }; }; /** - * Deprecated - Delete a custom role + * Closing down - Delete a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. * * Deletes a custom role from an organization. Once the custom role has been deleted, any * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." @@ -88956,10 +94674,10 @@ export interface operations { }; }; /** - * Deprecated - Update a custom role + * Closing down - Update a custom role * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. * * Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -89380,7 +95098,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-org-events": { parameters: { query?: { @@ -89408,6 +95130,10 @@ export interface operations { */ "teams/external-idp-group-info-for-org": { parameters: { + query?: { + per_page?: components["parameters"]["members-per-page"]; + page?: components["parameters"]["members-page"]; + }; path: { org: components["parameters"]["org"]; group_id: components["parameters"]["group-id"]; @@ -89456,7 +95182,10 @@ export interface operations { }; /** * List failed organization invitations - * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. + * @description The return hash contains `failed_at` and `failed_reason` fields which + * represent the time at which the invitation failed and the reason for the failure. + * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). */ "orgs/list-failed-invitations": { parameters: { @@ -89482,10 +95211,10 @@ export interface operations { }; }; /** - * Deprecated - List fine-grained permissions for an organization + * Closing down - List fine-grained permissions for an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after September 6, 2023. Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. * * Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -89763,7 +95492,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -89850,6 +95578,240 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + "api-insights/get-route-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-route-stats-sort"]; + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; + }; + }; + }; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + "api-insights/get-subject-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-subject-stats"]; + }; + }; + }; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + "api-insights/get-summary-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + "api-insights/get-summary-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + "api-insights/get-time-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + "api-insights/get-time-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + "api-insights/get-time-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + "api-insights/get-user-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; + }; + }; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. @@ -89970,7 +95932,12 @@ export interface operations { }; /** * List pending organization invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. + * @description The return hash contains a `role` field which refers to the Organization + * Invitation role and will be one of the following values: `direct_member`, `admin`, + * `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud + * member, the `login` field in the return hash will be `null`. + * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). */ "orgs/list-pending-invitations": { parameters: { @@ -90008,8 +95975,9 @@ export interface operations { * Create an organization invitation * @description Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + * + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. */ "orgs/create-invitation": { parameters: { @@ -90054,6 +96022,8 @@ export interface operations { * Cancel an organization invitation * @description Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). + * * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). */ "orgs/cancel-invitation": { @@ -90074,7 +96044,10 @@ export interface operations { }; /** * List organization invitation teams - * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + * @description List all teams associated with an invitation. In order to see invitations + * in an organization, the authenticated user must be an organization owner. + * + * This endpoint is not available for [Enterprise Managed User (EMU) organizations](https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users). */ "orgs/list-invitation-teams": { parameters: { @@ -90104,10 +96077,8 @@ export interface operations { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -90321,13 +96292,17 @@ export interface operations { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * Only organization owners can view Copilot seat assignment details for members of their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-seat-details-for-user": { parameters: { @@ -90385,7 +96360,7 @@ export interface operations { * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ "orgs/set-membership-for-user": { parameters: { @@ -90697,7 +96672,7 @@ export interface operations { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -90730,7 +96705,18 @@ export interface operations { }; /** * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific + * permissions over the organization and optionally across all repositories in the organization. For + * more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To include repository permissions in an organization role, you must also include the `base_role` + * field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of + * fine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions + * and can only be granted through the base role (like "reading a repo"). If you include repository permissions, those + * permissions apply across all of the repositories in the organization. You do not have to include organization permissions + * in order to add repository permissions. + * + * See "[List repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. * * To use this endpoint, the authenticated user must be one of: * @@ -90747,14 +96733,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; + "application/json": components["schemas"]["organization-custom-organization-role-create-schema"]; }; }; responses: { @@ -90771,7 +96750,7 @@ export interface operations { }; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -90793,7 +96772,7 @@ export interface operations { }; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -90824,7 +96803,7 @@ export interface operations { }; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -90847,7 +96826,7 @@ export interface operations { }; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -90869,7 +96848,7 @@ export interface operations { }; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -90900,7 +96879,7 @@ export interface operations { }; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -90923,7 +96902,7 @@ export interface operations { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -90979,6 +96958,10 @@ export interface operations { * Update a custom organization role * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * + * If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either + * previously or as part of the update. + * If the update sets the `base_role` field to `none`, you must also remove all of the repository + * permissions as well, otherwise the update will fail. * * To use this endpoint, the authenticated user must be one of: * @@ -90996,14 +96979,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** @description The name of the custom role. */ - name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions?: string[]; - }; + "application/json": components["schemas"]["organization-custom-organization-role-update-schema"]; }; }; responses: { @@ -91020,7 +96996,7 @@ export interface operations { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -91044,7 +97020,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -91059,7 +97035,7 @@ export interface operations { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -91083,7 +97059,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["user-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -91195,7 +97171,7 @@ export interface operations { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-organization": { parameters: { @@ -91234,7 +97210,7 @@ export interface operations { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-organization": { parameters: { @@ -91259,7 +97235,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-org": { parameters: { @@ -91289,7 +97265,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-org": { parameters: { @@ -91317,7 +97293,7 @@ export interface operations { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { @@ -91349,7 +97325,7 @@ export interface operations { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-organization": { parameters: { @@ -91375,7 +97351,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-org": { parameters: { @@ -91406,7 +97382,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-org": { parameters: { @@ -91706,6 +97682,232 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/list-org-private-registries": { + 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": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/create-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-public-key": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/delete-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/update-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. @@ -91784,7 +97986,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -91809,7 +98011,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -91817,7 +98019,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -91840,7 +98042,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -91864,32 +98066,14 @@ export interface operations { }; 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 | string[] | null; - /** @description Short description of the property */ - description?: string | null; - /** - * @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. - */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -92078,7 +98262,8 @@ export interface operations { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/list-for-org": { parameters: { @@ -92203,12 +98388,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -92225,7 +98412,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -92295,6 +98484,7 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; }; path: { org: components["parameters"]["org"]; @@ -92329,11 +98519,10 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -92362,6 +98551,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + ref?: components["parameters"]["ref-in-query"]; repository_name?: components["parameters"]["repository-name-in-query"]; time_period?: components["parameters"]["time-period"]; actor_name?: components["parameters"]["actor-name-in-query"]; @@ -92410,6 +98600,9 @@ export interface operations { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-org-ruleset": { parameters: { @@ -92450,11 +98643,9 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -92517,6 +98708,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { org: components["parameters"]["org"]; @@ -92574,11 +98767,9 @@ export interface operations { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. */ "orgs/list-security-manager-teams": { parameters: { @@ -92597,11 +98788,9 @@ export interface operations { }; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. */ "orgs/add-security-manager-team": { parameters: { @@ -92615,19 +98804,13 @@ export interface operations { 204: { content: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - content: never; - }; }; }; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles)" endpoints instead. */ "orgs/remove-security-manager-team": { parameters: { @@ -92771,24 +98954,70 @@ export interface operations { }; }; }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-team": { parameters: { @@ -92892,7 +99121,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -92917,7 +99146,8 @@ export interface operations { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Cloud replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ "teams/get-by-name": { parameters: { @@ -92942,7 +99172,8 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ "teams/delete-in-org": { parameters: { @@ -92962,7 +99193,8 @@ export interface operations { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ "teams/update-in-org": { parameters: { @@ -92998,7 +99230,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -93030,7 +99262,8 @@ export interface operations { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -93064,9 +99297,10 @@ export interface operations { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93105,7 +99339,8 @@ export interface operations { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -93130,7 +99365,8 @@ export interface operations { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93153,7 +99389,8 @@ export interface operations { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93188,7 +99425,8 @@ export interface operations { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -93221,9 +99459,10 @@ export interface operations { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93256,7 +99495,8 @@ export interface operations { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -93282,7 +99522,8 @@ export interface operations { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93306,7 +99547,8 @@ export interface operations { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93340,7 +99582,8 @@ export interface operations { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -93385,7 +99628,8 @@ export interface operations { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93434,7 +99678,8 @@ export interface operations { }; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * @@ -93461,7 +99706,8 @@ export interface operations { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -93505,7 +99751,8 @@ export interface operations { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -93553,7 +99800,8 @@ export interface operations { }; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * @@ -93654,7 +99902,8 @@ export interface operations { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ "teams/list-pending-invitations-in-org": { parameters: { @@ -93716,10 +99965,11 @@ export interface operations { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). */ @@ -93750,13 +100000,15 @@ export interface operations { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -93801,9 +100053,11 @@ export interface operations { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -93828,7 +100082,8 @@ export interface operations { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ "teams/list-projects-in-org": { parameters: { @@ -93857,7 +100112,8 @@ export interface operations { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -93884,7 +100140,8 @@ export interface operations { * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -93925,7 +100182,8 @@ export interface operations { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/remove-project-in-org": { parameters: { @@ -93946,7 +100204,8 @@ export interface operations { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ "teams/list-repos-in-org": { parameters: { @@ -93975,13 +100234,14 @@ export interface operations { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/check-permissions-for-repo-in-org": { parameters: { @@ -94013,7 +100273,8 @@ export interface operations { * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -94029,10 +100290,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -94048,7 +100306,8 @@ export interface operations { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/remove-repo-in-org": { parameters: { @@ -94072,7 +100331,8 @@ export interface operations { * * Team synchronization is available for organizations using 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. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ "teams/list-idp-groups-in-org": { parameters: { @@ -94096,7 +100356,8 @@ export interface operations { * * Team synchronization is available for organizations using 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. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ "teams/create-or-update-idp-group-connections-in-org": { parameters: { @@ -94133,7 +100394,8 @@ export interface operations { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ "teams/list-child-in-org": { parameters: { @@ -94160,11 +100422,15 @@ export interface operations { }; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -94854,7 +101120,8 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -94865,9 +101132,10 @@ export interface operations { * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/overview/api-versions)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { responses: { @@ -94890,7 +101158,8 @@ export interface operations { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/get": { parameters: { @@ -95002,6 +101271,16 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning automatic validity checks on supported partner tokens for this repository. */ secret_scanning_validity_checks?: { /** @description Can be `enabled` or `disabled`. */ @@ -95062,12 +101341,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -95084,7 +101365,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -96115,7 +102398,7 @@ export interface operations { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs-for-repo": { parameters: { @@ -96410,8 +102693,8 @@ export interface operations { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -97160,6 +103443,8 @@ export interface operations { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs": { parameters: { @@ -97339,6 +103624,103 @@ export interface operations { }; }; }; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/create-attestation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description response */ + 201: { + content: { + "application/json": { + /** @description The ID of the attestation. */ + id?: number; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. @@ -97459,13 +103841,13 @@ export interface operations { }; }; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { content: never; }; @@ -97511,7 +103893,7 @@ export interface operations { "repos/list-branches": { parameters: { query?: { - /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -97582,9 +103964,11 @@ export interface operations { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ "repos/update-branch-protection": { parameters: { @@ -97603,7 +103987,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -97825,7 +104209,8 @@ export interface operations { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ "repos/update-pull-request-review-protection": { parameters: { @@ -97886,7 +104271,8 @@ export interface operations { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ "repos/get-commit-signature-protection": { parameters: { @@ -98014,7 +104400,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -98160,7 +104546,8 @@ export interface operations { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ "repos/get-access-restrictions": { parameters: { @@ -98239,7 +104626,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -98271,7 +104658,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -98303,7 +104690,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -98483,7 +104870,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -98519,7 +104906,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -98555,7 +104942,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -98577,7 +104964,8 @@ export interface operations { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -98611,6 +104999,63 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + /** + * List repository push rule bypass requests + * @description Lists the requests made by users of a repository to bypass push protection rules + */ + "repos/list-repo-push-bypass-requests": { + parameters: { + query?: { + reviewer?: components["parameters"]["bypass-reviewer-name"]; + requester?: components["parameters"]["bypass-requester-name"]; + time_period?: components["parameters"]["time-period"]; + request_status?: components["parameters"]["bypass-request-status"]; + 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"]["push-rule-bypass-request"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get a repository push bypass request + * @description Get information about a request to bypass push protection rules for a repository. + */ + "repos/get-repo-push-bypass-request": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** + * @description The number that identifies the bypass request within the context of the given repository. + * @example 1 + */ + bypass_request_number: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["push-rule-bypass-request"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Create 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. @@ -98734,7 +105179,8 @@ export interface operations { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -98759,7 +105205,8 @@ export interface operations { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -98961,7 +105408,8 @@ export interface operations { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -99036,7 +105484,8 @@ export interface operations { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -99061,7 +105510,8 @@ export interface operations { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -99137,7 +105587,10 @@ export interface operations { page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; ref?: components["parameters"]["git-ref"]; + pr?: components["parameters"]["pr-alias"]; direction?: components["parameters"]["direction"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ @@ -99224,6 +105677,112 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/get-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/create-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/commit-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. @@ -99236,6 +105795,7 @@ export interface operations { page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; ref?: components["parameters"]["git-ref"]; + pr?: components["parameters"]["pr-alias"]; }; path: { owner: components["parameters"]["owner"]; @@ -99268,8 +105828,8 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -99280,6 +105840,7 @@ export interface operations { tool_guid?: components["parameters"]["tool-guid"]; page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; + pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -99446,7 +106007,7 @@ export interface operations { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ "code-scanning/list-codeql-databases": { parameters: { @@ -99473,11 +106034,11 @@ export interface operations { * * By default this endpoint returns JSON metadata about the CodeQL database. To * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types), and make sure + * to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ "code-scanning/get-codeql-database": { parameters: { @@ -99501,6 +106062,138 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/delete-codeql-database": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/enterprise-cloud@latest//code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "code-scanning/create-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description A Base64-encoded tarball containing a CodeQL query and all its dependencies */ + query_pack: string; + /** @description List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repositories?: string[]; + /** @description List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_lists?: string[]; + /** @description List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_owners?: string[]; + }; + }; + }; + responses: { + /** @description Variant analysis submitted for processing */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unable to process variant analysis submission */ + 422: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/get-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The unique identifier of the variant analysis. */ + codeql_variant_analysis_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/get-variant-analysis-repo-task": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + /** @description The name of the controller repository. */ + repo: string; + /** @description The ID of the variant analysis. */ + codeql_variant_analysis_id: number; + /** @description The account owner of the variant analysis repository. The name is not case sensitive. */ + repo_owner: string; + /** @description The name of the variant analysis repository. */ + repo_name: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. @@ -99597,6 +106290,8 @@ export interface operations { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -99682,6 +106377,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "code-security/get-configuration-for-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS @@ -99768,7 +106491,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -99996,8 +106719,6 @@ export interface operations { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ "codespaces/get-repo-public-key": { @@ -100168,7 +106889,7 @@ export interface operations { }; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -100247,7 +106968,8 @@ export interface operations { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -100503,7 +107225,8 @@ export interface operations { }; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). */ @@ -100535,6 +107258,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -100565,8 +107289,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - since?: components["parameters"]["since"]; - /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -100656,7 +107381,7 @@ export interface operations { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -100682,7 +107407,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -100737,7 +107462,8 @@ export interface operations { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -100755,6 +107481,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -100804,7 +107531,8 @@ export interface operations { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. * @@ -100846,7 +107574,8 @@ export interface operations { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -100996,7 +107725,7 @@ export interface operations { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." @@ -101011,6 +107740,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -101109,6 +107839,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -101117,7 +107848,8 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -101176,7 +107908,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -101190,7 +107929,8 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -101294,7 +108034,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -101902,7 +108642,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -101987,7 +108730,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -102040,7 +108783,8 @@ export interface operations { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -102067,9 +108811,11 @@ export interface operations { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -102353,7 +109099,9 @@ export interface operations { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -102748,7 +109496,8 @@ export interface operations { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-repo-events": { parameters: { @@ -102801,9 +109550,11 @@ export interface operations { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ "repos/create-fork": { parameters: { @@ -102872,7 +109623,14 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** @@ -102921,6 +109679,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -102954,7 +109713,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -103017,6 +109776,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -103061,7 +109821,8 @@ export interface operations { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -103090,7 +109851,8 @@ export interface operations { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ "git/get-ref": { parameters: { @@ -103218,6 +109980,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -103300,6 +110063,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -103414,8 +110178,8 @@ export interface operations { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ "git/get-tree": { parameters: { @@ -103547,7 +110311,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -103675,7 +110444,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -103761,7 +110529,8 @@ export interface operations { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ "repos/test-push-webhook": { parameters: { @@ -103784,7 +110553,8 @@ export interface operations { * @deprecated * @description View the progress of an import. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -103844,7 +110614,8 @@ export interface operations { * 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -103893,7 +110664,8 @@ export interface operations { * @deprecated * @description Stop an import for a repository. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -103920,7 +110692,8 @@ 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -103967,7 +110740,8 @@ export interface operations { * * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -103996,7 +110770,8 @@ export interface operations { * @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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -104033,7 +110808,8 @@ export interface operations { * @deprecated * @description List files larger than 100MB found during the import * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -104061,7 +110837,8 @@ export interface operations { * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -104265,10 +111042,8 @@ export interface operations { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -104322,7 +111097,7 @@ export interface operations { * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -104346,7 +111121,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: string | number | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -104600,7 +111375,8 @@ export interface operations { }; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). */ @@ -104681,10 +111457,8 @@ export interface operations { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -104716,7 +111490,7 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -104740,7 +111514,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -104920,7 +111694,7 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -105304,7 +112078,8 @@ export interface operations { }; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). */ @@ -105324,6 +112099,173 @@ export interface operations { }; }; }; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + "issues/remove-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + "issues/list-sub-issues": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + "issues/add-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + "issues/reprioritize-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. @@ -106072,7 +113014,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//articles/using-a-custom-domain-with-github-pages/)." */ + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -106645,7 +113587,7 @@ export interface operations { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -106918,7 +113860,8 @@ export interface operations { }; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -106954,7 +113897,7 @@ export interface operations { * * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -106973,7 +113916,7 @@ export interface operations { }; }; responses: { - /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ + /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -107057,7 +114000,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -107145,9 +114088,9 @@ export interface operations { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -107176,7 +114119,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -107225,7 +114168,7 @@ export interface operations { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -107307,8 +114250,8 @@ export interface operations { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -107370,7 +114313,7 @@ export interface operations { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." */ "pulls/merge": { parameters: { @@ -107558,11 +114501,12 @@ export interface operations { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -107764,9 +114708,8 @@ export interface operations { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -107856,6 +114799,7 @@ export interface operations { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -107914,6 +114858,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -107985,7 +114930,7 @@ export interface operations { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." */ "repos/create-release": { parameters: { @@ -108053,7 +114998,13 @@ export interface operations { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ "repos/get-release-asset": { parameters: { @@ -108207,9 +115158,8 @@ export interface operations { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ "repos/get-release": { parameters: { @@ -108453,7 +115403,8 @@ export interface operations { }; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). */ @@ -108512,6 +115463,7 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; }; path: { owner: components["parameters"]["owner"]; @@ -108548,8 +115500,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -108631,6 +115582,9 @@ export interface operations { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-repo-ruleset": { parameters: { @@ -108677,8 +115631,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -108745,6 +115697,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { owner: components["parameters"]["owner"]; @@ -108880,6 +115834,78 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "secret-scanning/create-push-protection-bypass": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + content: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + content: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + "secret-scanning/get-scan-history": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List repository security advisories * @description Lists security advisories in a repository. @@ -109077,7 +116103,8 @@ export interface operations { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ "security-advisories/create-fork": { parameters: { @@ -109136,11 +116163,10 @@ export interface operations { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ "repos/get-code-frequency-stats": { parameters: { @@ -109196,7 +116222,8 @@ export interface operations { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ "repos/get-contributors-stats": { parameters: { @@ -109444,8 +116471,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -109468,8 +116499,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -109499,8 +116534,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -109525,7 +116564,9 @@ export interface operations { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -109611,7 +116652,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -109815,7 +116856,8 @@ export interface operations { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ "repos/download-zipball-archive": { parameters: { @@ -109917,9 +116959,7 @@ export interface operations { }; /** * List provisioned SCIM groups for an enterprise - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Lists provisioned SCIM groups in an enterprise. + * @description Lists provisioned SCIM groups in an enterprise. * * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. */ @@ -109952,9 +116992,7 @@ export interface operations { }; /** * Provision a SCIM enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Creates a SCIM group for an enterprise. + * @description Creates a SCIM group for an enterprise. * * When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. */ @@ -109986,9 +117024,7 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Gets information about a SCIM group. + * @description Gets information about a SCIM group. */ "enterprise-admin/get-provisioning-information-for-enterprise-group": { parameters: { @@ -110017,9 +117053,7 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Replaces an existing provisioned group’s information. + * @description Replaces an existing provisioned group’s information. * * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ @@ -110053,9 +117087,7 @@ export interface operations { }; /** * Delete a SCIM group from an enterprise - * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. - * - * Deletes a SCIM group from an enterprise. + * @description Deletes a SCIM group from an enterprise. */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { @@ -110079,15 +117111,14 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Update a provisioned group’s individual attributes. + * @description Update a provisioned group’s individual attributes. * * To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. * * You can submit group memberships individually or in batches for improved efficiency. * - * **Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here. + * > [!NOTE] + * > Memberships are referenced via a local user id. Ensure users are created before referencing them here. */ "enterprise-admin/update-attribute-for-enterprise-group": { parameters: { @@ -110123,9 +117154,7 @@ export interface operations { }; /** * List SCIM provisioned identities for an enterprise - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Lists provisioned SCIM enterprise members. + * @description Lists provisioned SCIM enterprise members. * * When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. */ @@ -110157,9 +117186,7 @@ export interface operations { }; /** * Provision a SCIM enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Creates an external identity for a new SCIM enterprise user. + * @description Creates an external identity for a new SCIM enterprise user. * * SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. */ @@ -110191,9 +117218,7 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Gets information about a SCIM user. + * @description Gets information about a SCIM user. */ "enterprise-admin/get-provisioning-information-for-enterprise-user": { parameters: { @@ -110219,13 +117244,12 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Replaces an existing provisioned user's information. + * @description Replaces an existing provisioned user's information. * * You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. + * > [!WARNING] + * > Setting `active: false` will suspend a user, and their handle and email will be obfuscated. */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { @@ -110257,9 +117281,7 @@ export interface operations { }; /** * Delete a SCIM user from an enterprise - * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. - * - * Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. + * @description Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. */ "enterprise-admin/delete-user-from-enterprise": { parameters: { @@ -110283,26 +117305,25 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Update a provisioned user's individual attributes. + * @description Update a provisioned user's individual attributes. * * To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. - * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. - * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user, and their handle and email will be obfuscated. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { @@ -110461,7 +117482,10 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** Get SCIM provisioning information for a user */ + /** + * Get SCIM provisioning information for a user + * @description Gets SCIM provisioning information for a user. + */ "scim/get-provisioning-information-for-user": { parameters: { path: { @@ -110487,7 +117511,8 @@ export interface operations { * * You must at least provide the required values for the user: `userName`, `name`, and `emails`. * - * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. + * > [!WARNING] + * > Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ "scim/set-information-for-provisioned-user": { parameters: { @@ -110557,7 +117582,10 @@ export interface operations { 404: components["responses"]["scim_not_found"]; }; }; - /** Delete a SCIM user from an organization */ + /** + * Delete a SCIM user from an organization + * @description Deletes a SCIM user from an organization. + */ "scim/delete-user-from-org": { parameters: { path: { @@ -110579,20 +117607,21 @@ export interface operations { * Update an attribute for a SCIM user * @description Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. - * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ "scim/update-attribute-for-user": { parameters: { @@ -110689,12 +117718,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; per_page?: components["parameters"]["per-page"]; @@ -110768,7 +117797,8 @@ export interface operations { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ "search/issues-and-pull-requests": { parameters: { @@ -110973,7 +118003,8 @@ export interface operations { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. */ "teams/get-legacy": { parameters: { @@ -110994,7 +118025,8 @@ export interface operations { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -111018,11 +118050,13 @@ export interface operations { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -111057,7 +118091,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -111088,7 +118122,8 @@ export interface operations { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -111120,11 +118155,12 @@ export interface operations { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -111161,7 +118197,8 @@ export interface operations { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -111186,7 +118223,8 @@ export interface operations { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -111209,7 +118247,8 @@ export interface operations { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -111244,7 +118283,8 @@ export interface operations { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -111277,11 +118317,12 @@ export interface operations { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -111312,7 +118353,8 @@ export interface operations { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -111338,7 +118380,8 @@ export interface operations { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -111362,7 +118405,8 @@ export interface operations { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -111396,7 +118440,8 @@ export interface operations { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * @@ -111439,7 +118484,8 @@ export interface operations { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * @@ -111486,7 +118532,8 @@ export interface operations { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * @@ -111528,7 +118575,8 @@ export interface operations { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * @@ -111574,7 +118622,8 @@ export interface operations { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. */ @@ -111603,7 +118652,8 @@ export interface operations { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -111635,7 +118685,7 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -111662,7 +118712,7 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -111670,7 +118720,8 @@ export interface operations { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -111700,7 +118751,7 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -111708,7 +118759,8 @@ export interface operations { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-member-legacy": { parameters: { @@ -111731,7 +118783,8 @@ export interface operations { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -111762,13 +118815,15 @@ export interface operations { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -111814,13 +118869,15 @@ export interface operations { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-membership-for-user-legacy": { parameters: { @@ -111843,7 +118900,8 @@ export interface operations { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -111873,7 +118931,8 @@ export interface operations { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -111900,7 +118959,8 @@ export interface operations { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -111943,7 +119003,8 @@ export interface operations { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -111966,7 +119027,8 @@ export interface operations { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. */ "teams/list-repos-legacy": { parameters: { @@ -111994,11 +119056,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -112028,7 +119092,8 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -112065,7 +119130,8 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -112087,7 +119153,8 @@ export interface operations { /** * List IdP groups for a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. * * Team synchronization is available for organizations using 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. * @@ -112113,7 +119180,8 @@ export interface operations { /** * Create or update IdP group connections (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. * * Team synchronization is available for organizations using 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. * @@ -112162,7 +119230,8 @@ export interface operations { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. */ "teams/list-child-legacy": { parameters: { @@ -112412,7 +119481,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -112444,7 +119513,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -113223,6 +120292,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -113428,6 +120498,8 @@ export interface operations { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -113449,6 +120521,8 @@ export interface operations { /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -113527,10 +120601,8 @@ export interface operations { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -114062,6 +121134,9 @@ export interface operations { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -114089,7 +121164,7 @@ export interface operations { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-authenticated-user": { parameters: { @@ -114121,7 +121196,7 @@ export interface operations { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-authenticated-user": { parameters: { @@ -114143,7 +121218,7 @@ export interface operations { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-authenticated-user": { parameters: { @@ -114170,7 +121245,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-authenticated-user": { parameters: { @@ -114197,7 +121272,7 @@ export interface operations { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { @@ -114228,7 +121303,7 @@ export interface operations { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-authenticated-user": { parameters: { @@ -114253,7 +121328,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-authenticated-user": { parameters: { @@ -114281,7 +121356,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-authenticated-user": { parameters: { @@ -114505,7 +121580,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -114522,7 +121599,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -114996,6 +122075,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails)". + */ + "users/get-by-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts. @@ -115049,6 +122154,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/enterprise-cloud@latest//actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "users/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + bundle?: components["schemas"]["sigstore-bundle-0"]; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. @@ -115074,7 +122226,10 @@ export interface operations { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-events-for-authenticated-user": { parameters: { @@ -115098,6 +122253,9 @@ export interface operations { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-org-events-for-authenticated-user": { parameters: { @@ -115119,7 +122277,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-user": { parameters: { query?: { @@ -115374,7 +122536,7 @@ export interface operations { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-user": { parameters: { @@ -115411,7 +122573,7 @@ export interface operations { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-user": { parameters: { @@ -115436,7 +122598,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-user": { parameters: { @@ -115466,7 +122628,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-user": { parameters: { @@ -115494,7 +122656,7 @@ export interface operations { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { @@ -115520,7 +122682,7 @@ export interface operations { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-user": { parameters: { @@ -115546,7 +122708,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-user": { parameters: { @@ -115577,7 +122739,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-user": { parameters: { @@ -115629,7 +122791,11 @@ export interface operations { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-received-events-for-user": { parameters: { @@ -115650,7 +122816,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-received-public-events-for-user": { parameters: { query?: { diff --git a/packages/openapi-types-ghes-3.12/package.json b/packages/openapi-types-ghes-3.12/package.json index 56c0e10cb..cc9dda61d 100644 --- a/packages/openapi-types-ghes-3.12/package.json +++ b/packages/openapi-types-ghes-3.12/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.6.0" + "openapi-version": "17.1.0" } } diff --git a/packages/openapi-types-ghes-3.12/types.d.ts b/packages/openapi-types-ghes-3.12/types.d.ts index 54a7d77e9..8a400f121 100644 --- a/packages/openapi-types-ghes-3.12/types.d.ts +++ b/packages/openapi-types-ghes-3.12/types.d.ts @@ -306,8 +306,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/enterprise-server@3.12/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -332,7 +330,8 @@ export interface paths { /** * List your grants * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.12/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ @@ -342,13 +341,15 @@ export interface paths { /** * Get a single grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ get: operations["oauth-authorizations/get-grant"]; /** * Delete a grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -357,7 +358,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; @@ -365,17 +366,17 @@ export interface paths { "/applications/{client_id}/token": { /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -387,17 +388,14 @@ export interface paths { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; }; @@ -405,17 +403,20 @@ export interface paths { /** * List your authorizations * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ get: operations["oauth-authorizations/list-authorizations"]; /** * Create a new authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.12/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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/authentication/authenticating-to-the-rest-api#using-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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * @@ -429,15 +430,15 @@ export interface paths { /** * Get-or-create an authorization for a specific app * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * * 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; }; @@ -445,9 +446,11 @@ export interface paths { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * @@ -459,19 +462,22 @@ export interface paths { /** * Get a single authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ get: operations["oauth-authorizations/get-authorization"]; /** * Delete an authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ delete: operations["oauth-authorizations/delete-authorization"]; /** * Update an existing authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * * 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * @@ -998,7 +1004,8 @@ export interface paths { "/events": { /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; }; @@ -1017,7 +1024,8 @@ export interface paths { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -1031,7 +1039,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; }; @@ -1190,10 +1199,8 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1243,36 +1250,46 @@ export interface paths { */ get: operations["enterprise-admin/get-checks-system-requirements"]; }; + "/manage/v1/cluster/status": { + /** + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. + */ + get: operations["enterprise-admin/get-cluster-status"]; + }; "/manage/v1/config/apply": { /** * Get the status of a ghe-config-apply run * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. */ - get: operations["enterprise-admin/get-manage-settings"]; + get: operations["enterprise-admin/get-manage-config-apply-status"]; /** * Trigger a ghe-config-apply run * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. * You can provide a run ID or allow one to be generated randomly. */ - post: operations["enterprise-admin/get-manage-settings"]; + post: operations["enterprise-admin/post-manage-run-config-apply"]; }; "/manage/v1/config/apply/events": { /** * List events from ghe-config-apply * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. */ - get: operations["enterprise-admin/get-manage-settings"]; + get: operations["enterprise-admin/get-manage-config-apply-events"]; }; "/manage/v1/config/init": { /** - * Initialize instance configuration with license upload - * @description When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. * - * Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) * - * This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/initialize-instance-configuration"]; }; @@ -1284,7 +1301,10 @@ export interface paths { get: operations["enterprise-admin/license-info"]; /** * Upload an enterprise license - * @description Uploads an enterprise license. This operation does not automatically activate the license. + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ put: operations["enterprise-admin/license-upload"]; }; @@ -1361,7 +1381,11 @@ export interface paths { get: operations["meta/get"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; }; "/notifications": { @@ -1423,16 +1447,17 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; }; "/organizations/{organization_id}/custom_roles": { /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -1451,17 +1476,6 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1480,21 +1494,11 @@ export interface paths { delete: operations["orgs/delete"]; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -2408,7 +2412,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; }; "/orgs/{org}/external-group/{group_id}": { @@ -2432,7 +2440,9 @@ export interface paths { "/orgs/{org}/hooks": { /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2463,7 +2473,9 @@ export interface paths { get: operations["orgs/get-webhook"]; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2581,10 +2593,8 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -2630,7 +2640,7 @@ export interface paths { * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; /** @@ -2721,7 +2731,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; }; @@ -2730,7 +2740,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; /** @@ -2739,7 +2749,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; }; @@ -2754,7 +2764,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; }; @@ -2763,7 +2773,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; }; @@ -2772,7 +2782,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; /** @@ -2781,7 +2791,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; }; @@ -2796,7 +2806,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; }; @@ -2932,7 +2942,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; /** @@ -2986,6 +2997,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -3073,7 +3087,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; /** @@ -3082,14 +3097,16 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; }; @@ -3098,7 +3115,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3107,9 +3125,10 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3120,7 +3139,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3129,7 +3149,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3138,7 +3159,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3149,7 +3171,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3158,9 +3181,10 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3171,7 +3195,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3180,7 +3205,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3189,7 +3215,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3200,7 +3227,8 @@ export interface paths { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3211,7 +3239,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3220,7 +3249,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -3233,7 +3263,8 @@ export interface paths { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3244,7 +3275,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3253,7 +3285,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * @@ -3300,10 +3333,11 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#create-a-team). */ @@ -3314,13 +3348,15 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; /** @@ -3329,9 +3365,11 @@ export interface paths { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; }; @@ -3340,7 +3378,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; }; @@ -3349,21 +3388,24 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; }; @@ -3372,7 +3414,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; }; @@ -3381,20 +3424,22 @@ export interface paths { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.12/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -3403,7 +3448,8 @@ export interface paths { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; }; @@ -3412,7 +3458,8 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; }; @@ -3423,7 +3470,7 @@ export interface paths { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -3530,7 +3577,8 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -3541,9 +3589,10 @@ export interface paths { * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.12/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.12/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.12/rest/overview/api-versions)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.12/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; }; @@ -3552,7 +3601,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; /** @@ -3964,7 +4014,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; }; @@ -4057,8 +4107,8 @@ export interface paths { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -4306,6 +4356,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; }; @@ -4394,9 +4446,11 @@ export interface paths { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; /** @@ -4443,7 +4497,8 @@ export interface paths { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; }; @@ -4454,7 +4509,8 @@ export interface paths { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.12/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; /** @@ -4520,7 +4576,8 @@ export interface paths { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; /** @@ -4638,7 +4695,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -4662,7 +4720,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4671,7 +4730,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4702,7 +4762,8 @@ export interface paths { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.12/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4721,7 +4782,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4732,7 +4794,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4798,8 +4861,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -4947,6 +5010,8 @@ export interface paths { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -4997,7 +5062,7 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.12/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -5032,7 +5097,8 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -5110,7 +5176,8 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.12/rest/commits/comments#get-a-commit-comment). */ @@ -5129,6 +5196,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5176,7 +5244,7 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -5201,7 +5269,8 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -5219,6 +5288,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5245,7 +5315,8 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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.12/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.12/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * @@ -5258,7 +5329,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5307,7 +5379,7 @@ export interface paths { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api)." @@ -5322,6 +5394,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5377,7 +5450,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -5392,7 +5466,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -5621,7 +5696,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -5632,9 +5708,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5713,7 +5791,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -5849,7 +5929,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; }; @@ -5860,9 +5941,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; }; @@ -5899,6 +5982,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5937,6 +6021,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5965,7 +6050,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -5976,7 +6062,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; }; @@ -6014,6 +6101,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -6048,6 +6136,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -6087,8 +6176,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; }; @@ -6111,7 +6200,12 @@ export interface paths { * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -6168,7 +6262,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; }; @@ -6199,10 +6294,8 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6216,7 +6309,7 @@ export interface paths { * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.12/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6290,7 +6383,8 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.12/rest/issues/comments#get-an-issue-comment). */ @@ -6320,10 +6414,8 @@ export interface paths { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/enterprise-server@3.12/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6335,7 +6427,7 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6390,7 +6482,7 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6467,7 +6559,8 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.12/rest/issues/issues#get-an-issue). */ @@ -6757,7 +6850,7 @@ export interface paths { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6829,7 +6922,8 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.12/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -6852,7 +6946,7 @@ export interface paths { * * If merged via a [squash](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * * If [rebased](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6898,9 +6992,9 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6917,7 +7011,7 @@ export interface paths { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6950,8 +7044,8 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6971,7 +7065,7 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; }; @@ -7009,11 +7103,12 @@ export interface paths { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -7083,9 +7178,8 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.12/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.12/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7114,6 +7208,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -7153,14 +7248,20 @@ export interface paths { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; /** Delete a release asset */ @@ -7199,9 +7300,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; /** @@ -7257,7 +7357,8 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.12/rest/releases/releases#get-a-release). */ @@ -7312,6 +7413,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -7468,23 +7572,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -7495,7 +7611,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -7549,7 +7667,8 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; }; @@ -7576,7 +7695,8 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -7585,7 +7705,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -7596,14 +7717,16 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -7612,14 +7735,16 @@ export interface paths { put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -7632,7 +7757,8 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -7641,7 +7767,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -7654,50 +7781,57 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; }; @@ -7753,7 +7887,8 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.12/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.12/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; }; @@ -7852,7 +7987,8 @@ export interface paths { get: operations["enterprise-admin/get-maintenance-status"]; /** * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * @description > [!NOTE] + * > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; }; @@ -7861,7 +7997,8 @@ export interface paths { * Get settings * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * > [!NOTE] + * > You cannot retrieve the management console password with the Enterprise administration API. */ get: operations["enterprise-admin/get-settings"]; /** @@ -7901,7 +8038,8 @@ export interface paths { * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/create-enterprise-server-license"]; }; @@ -7910,7 +8048,8 @@ export interface paths { * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/upgrade-license"]; }; @@ -7918,13 +8057,15 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -7934,11 +8075,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -7946,7 +8089,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -7956,11 +8100,12 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7970,7 +8115,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -7980,7 +8126,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -7990,7 +8137,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -8002,7 +8150,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -8012,11 +8161,12 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -8026,7 +8176,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -8036,7 +8187,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -8046,7 +8198,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -8058,7 +8211,8 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -8068,7 +8222,8 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -8082,7 +8237,8 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * @@ -8092,7 +8248,8 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * @@ -8106,7 +8263,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.12/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.12/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -8116,7 +8274,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -8126,7 +8284,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -8134,7 +8292,8 @@ export interface paths { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -8142,7 +8301,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -8150,7 +8309,8 @@ export interface paths { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; }; @@ -8158,7 +8318,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -8173,13 +8334,15 @@ export interface paths { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -8189,13 +8352,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; }; @@ -8203,7 +8368,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -8213,7 +8379,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -8221,7 +8388,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -8229,7 +8397,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -8239,7 +8408,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; }; @@ -8247,17 +8417,20 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -8267,7 +8440,8 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -8277,7 +8451,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; }; @@ -8410,11 +8585,15 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -8423,10 +8602,8 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -8540,6 +8717,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -8548,7 +8728,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; }; @@ -8557,14 +8737,14 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; /** * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; }; @@ -8577,7 +8757,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; }; @@ -8586,7 +8766,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; }; @@ -8595,7 +8775,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; /** @@ -8604,7 +8784,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; }; @@ -8617,7 +8797,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; }; @@ -8768,6 +8948,17 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.12/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users @@ -8800,7 +8991,10 @@ export interface paths { "/users/{username}/events": { /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; }; @@ -8808,11 +9002,18 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; }; "/users/{username}/followers": { @@ -8888,7 +9089,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; }; @@ -8897,7 +9098,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; /** @@ -8906,7 +9107,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; }; @@ -8921,7 +9122,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; }; @@ -8930,7 +9131,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; }; @@ -8939,7 +9140,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; /** @@ -8948,7 +9149,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; }; @@ -8963,7 +9164,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; }; @@ -8977,12 +9178,20 @@ export interface paths { "/users/{username}/received_events": { /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -9105,6 +9314,22 @@ export interface paths { */ get: operations["repos/compare-commits"]; }; + "/orgs/{org}/organization-fine-grained-permissions": { + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + }; } export type webhooks = Record; @@ -9216,9 +9441,11 @@ export interface components { ping_url?: string; }; "public-key-full": { + /** Format: int64 */ id: number; key: string; user_id: number | null; + /** Format: int64 */ repository_id: number | null; url: string; title: string; @@ -9254,7 +9481,10 @@ export interface components { ldap_dn?: string; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9368,6 +9598,8 @@ export interface components { /** Format: date-time */ suspended_at?: string | null; business_plus?: boolean; + /** @example public */ + user_view_type?: string; }; /** * Organization Simple @@ -9409,6 +9641,7 @@ export interface components { description: string | null; }; "pre-receive-environment": { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9442,6 +9675,7 @@ export interface components { html_url?: string; }; environment?: { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9468,7 +9702,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9527,6 +9764,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * App Permissions @@ -9675,7 +9914,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -9710,7 +9949,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -9784,7 +10023,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9843,6 +10085,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** Scoped Installation */ "nullable-scoped-installation": { @@ -9875,6 +10119,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -9935,6 +10180,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ vulnerable_functions: readonly string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; /** * @description The type of credit the user is receiving. * @enum {string} @@ -10033,6 +10292,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -10041,6 +10301,10 @@ export interface components { name: string; }[] | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; /** @description In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available. */ credits: | readonly { @@ -10141,8 +10405,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -10238,6 +10500,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -10328,6 +10596,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -10515,6 +10789,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -10806,7 +11081,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10893,7 +11168,10 @@ export interface components { * @description The authorization associated with an OAuth Access. */ "application-grant": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * Format: uri @@ -11391,9 +11669,9 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -11409,10 +11687,10 @@ export interface components { * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -11420,8 +11698,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -11434,6 +11710,8 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -11495,6 +11773,7 @@ export interface components { */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -11827,6 +12106,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -11960,7 +12240,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -12169,8 +12449,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -12207,6 +12485,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -12314,6 +12598,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -12473,6 +12758,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -12496,7 +12786,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -12527,6 +12819,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -12544,8 +12838,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -12654,6 +12946,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -12918,6 +13215,20 @@ export interface components { }[]; }[]; }; + /** @enum {string} */ + "ghes-cluster-status-indicator": "UNKNOWN" | "OK" | "WARNING" | "CRITICAL"; + "ghes-cluster-status": { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + nodes?: { + hostname?: string; + status?: components["schemas"]["ghes-cluster-status-indicator"]; + services?: { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + name?: string; + details?: string; + }[]; + }[]; + }; /** Initialize configuration with license upload */ "ghes-config-init-request": { /** @description The content of your _.ghl_ license file. */ @@ -13056,13 +13367,13 @@ export interface components { ldap?: { host?: string | null; port?: number; - base?: unknown[]; + base?: string[]; uid?: string | null; bind_dn?: string | null; password?: string | null; method?: string; search_strategy?: string; - user_groups?: unknown[]; + user_groups?: string[]; admin_group?: string | null; virtual_attribute_enabled?: boolean; recursive_group_search?: boolean; @@ -13240,18 +13551,25 @@ export interface components { * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ - dependabot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; /** @example 3.12.0 */ installed_version?: string; @@ -13283,7 +13601,10 @@ export interface components { * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -13649,7 +13970,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -13694,40 +14020,35 @@ export interface components { */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @description Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -14009,7 +14330,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14478,7 +14802,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -14609,6 +14936,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14621,7 +14952,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -14645,6 +14976,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14730,6 +15065,7 @@ export interface components { */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -15021,7 +15357,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -15105,7 +15441,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -15419,7 +15758,7 @@ export interface components { description: 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. + * @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 not available for the `repository` target. * @enum {string} */ "repository-rule-enforcement": "disabled" | "active" | "evaluate"; @@ -15440,8 +15779,8 @@ export interface components { | "RepositoryRole" | "Team"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -15484,7 +15823,10 @@ export interface components { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & @@ -15547,6 +15889,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -15555,6 +15909,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -15585,6 +15941,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -15726,6 +16084,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -15789,7 +16149,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: | ( @@ -15872,10 +16232,10 @@ export interface components { */ 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} + * @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`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -15898,8 +16258,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @@ -16794,6 +17154,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -16909,6 +17270,7 @@ export interface components { code_scanning_upload?: components["schemas"]["rate-limit"]; actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -17236,6 +17598,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -17243,6 +17606,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17252,6 +17616,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17523,6 +17888,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -17574,6 +17940,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -17859,6 +18226,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -17876,6 +18244,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -17931,8 +18300,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -18126,8 +18498,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -18345,6 +18723,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -18502,7 +18881,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -18607,7 +18989,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -18707,6 +19089,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -18749,6 +19132,7 @@ export interface components { query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -18852,7 +19236,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -18920,6 +19307,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; }; /** * Collaborator @@ -18928,7 +19317,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -18996,6 +19388,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -19076,7 +19470,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -19311,6 +19708,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -19324,7 +19722,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -19528,6 +19925,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -19562,6 +19975,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -19674,6 +20088,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -19693,11 +20112,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -19708,7 +20125,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -19745,6 +20162,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -19763,6 +20185,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -19890,7 +20323,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -19922,7 +20358,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -19981,6 +20417,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -20459,6 +20896,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -20595,6 +21033,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -21012,6 +21451,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -21028,14 +21468,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -21246,11 +21692,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -21271,12 +21719,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -21788,7 +22236,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -21897,359 +22348,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -22317,6 +22425,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -22370,9 +22479,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -22625,7 +22740,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -22735,7 +22850,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -22744,7 +22859,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -23432,6 +23547,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -23658,6 +23779,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -23703,6 +23825,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; "configuration-status": { status?: string; @@ -23868,8 +23991,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -23938,6 +24065,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -23979,8 +24111,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -24006,7 +24136,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -24046,6 +24179,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -24087,6 +24221,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -24257,6 +24392,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -24692,7 +24828,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -24753,75 +24889,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -25056,6 +25123,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -25125,6 +25193,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25144,6 +25213,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -25203,6 +25273,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25222,6 +25293,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -25267,6 +25339,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -25354,6 +25427,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25373,7 +25447,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -25431,6 +25507,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25450,6 +25527,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -25567,6 +25645,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25586,6 +25665,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -25643,6 +25723,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -25679,6 +25760,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -25774,6 +25856,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -25904,6 +25987,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -26011,6 +26095,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -26045,6 +26135,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26064,6 +26155,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26112,6 +26204,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26185,6 +26278,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -26221,6 +26315,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -26316,6 +26411,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26444,6 +26540,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -26551,6 +26648,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -26585,6 +26688,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26604,6 +26708,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -26642,6 +26747,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Team @@ -26714,6 +26820,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -27149,7 +27256,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -27256,6 +27363,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -27309,6 +27417,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27328,6 +27437,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -27396,6 +27506,10 @@ export interface components { | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -27451,6 +27565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -27507,6 +27622,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -27669,7 +27785,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -27762,6 +27878,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -27858,6 +27975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -27985,7 +28103,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -28078,6 +28199,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -28167,6 +28289,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28186,6 +28309,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -28325,7 +28449,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -28418,6 +28545,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -28507,6 +28635,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28526,6 +28655,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -28593,6 +28723,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -28640,6 +28771,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -28848,6 +28980,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28867,6 +29000,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -29001,6 +29135,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29020,6 +29155,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -29081,6 +29217,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29100,6 +29237,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -29206,6 +29344,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -29353,6 +29492,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -29513,6 +29653,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -29565,6 +29706,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -29604,6 +29746,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -29641,6 +29784,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -29754,7 +29898,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -29764,7 +29908,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -29775,7 +29919,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -29786,7 +29930,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -29810,6 +29954,13 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -29823,7 +29974,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-cache-sync": { after: string; @@ -29834,7 +29985,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -29844,7 +29995,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -29862,7 +30013,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -29885,7 +30036,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -29903,7 +30054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -29989,6 +30140,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -30028,6 +30181,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -30221,7 +30375,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -30300,6 +30454,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -30339,6 +30495,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -30525,7 +30682,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -30599,6 +30756,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -30638,6 +30797,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -30823,7 +30983,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -30877,6 +31037,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -30953,7 +31114,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -31007,6 +31168,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31090,7 +31252,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -31165,9 +31327,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -31185,7 +31347,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -31239,6 +31401,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31324,7 +31487,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -31417,7 +31580,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -31501,7 +31664,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -31510,7 +31673,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/enterprise-server@3.12/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -31577,6 +31740,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -31596,13 +31760,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; 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"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -31621,7 +31786,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** delete event */ "webhook-delete": { @@ -31636,7 +31801,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -31647,7 +31812,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -31658,7 +31823,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -31669,7 +31834,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -31680,7 +31845,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -31691,7 +31856,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -31702,7 +31867,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -31713,7 +31878,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -31724,7 +31889,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -31735,7 +31900,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -31783,6 +31948,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -31896,6 +32062,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31992,7 +32159,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -32032,6 +32199,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -32282,6 +32450,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32309,7 +32478,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -32321,7 +32490,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -32372,6 +32541,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -32448,6 +32618,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32560,6 +32731,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32622,6 +32794,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32641,7 +32814,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -32692,6 +32865,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -32767,6 +32941,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32879,6 +33054,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32940,6 +33116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32996,11 +33173,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -33050,6 +33228,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33125,6 +33304,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33237,6 +33417,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33299,6 +33480,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33394,6 +33576,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -33507,6 +33690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33638,6 +33822,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -33756,6 +33941,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33849,7 +34035,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -33889,6 +34075,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -34140,6 +34327,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -34159,7 +34347,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -34187,7 +34375,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -34198,7 +34386,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -34210,7 +34398,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -34222,7 +34410,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -34239,7 +34427,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -34250,7 +34438,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -34261,7 +34449,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -34280,7 +34468,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -34292,7 +34480,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -34303,7 +34491,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -34314,7 +34502,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -34325,7 +34513,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -34340,7 +34528,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -34350,7 +34538,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -34362,7 +34550,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -34373,7 +34561,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -34384,17 +34572,17 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-disabled": { /** @enum {string} */ action: "anonymous_access_disabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-enabled": { /** @enum {string} */ action: "anonymous_access_enabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** * fork event @@ -34455,10 +34643,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -34515,7 +34699,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -34591,6 +34778,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -34742,13 +34930,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -34776,7 +34964,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -34788,7 +34976,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -34800,7 +34988,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -34812,7 +35000,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -34836,7 +35024,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -34860,7 +35048,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -34872,7 +35060,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -34912,6 +35100,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -34927,7 +35116,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -34940,7 +35129,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -35018,6 +35207,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35037,6 +35227,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -35086,6 +35277,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35122,6 +35314,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35217,6 +35410,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35347,6 +35541,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35454,6 +35649,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35488,6 +35689,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35507,6 +35709,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -35546,6 +35749,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -35608,6 +35812,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -35623,7 +35828,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -35677,6 +35882,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35713,6 +35919,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35808,6 +36015,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35936,6 +36144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36043,6 +36252,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36077,6 +36292,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36096,6 +36312,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36135,6 +36352,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -36197,6 +36415,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36208,11 +36427,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -36267,6 +36487,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36303,6 +36524,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36398,6 +36620,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36528,6 +36751,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36635,6 +36859,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36669,6 +36899,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36688,6 +36919,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36727,6 +36959,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -36789,6 +37022,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36804,7 +37038,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -36819,7 +37053,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -36875,6 +37109,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36911,6 +37146,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37006,6 +37242,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37137,6 +37374,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37244,6 +37482,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37278,6 +37522,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37297,6 +37542,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -37345,6 +37591,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -37356,11 +37603,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -37416,6 +37664,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37547,6 +37796,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37676,6 +37926,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37783,6 +38034,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37817,6 +38074,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37836,11 +38094,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -38027,6 +38286,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38155,6 +38415,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38262,6 +38523,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38296,6 +38563,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38315,12 +38583,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -38387,6 +38656,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38518,6 +38788,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38649,6 +38920,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38756,6 +39028,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38790,6 +39068,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38809,12 +39088,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -38870,6 +39150,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39001,6 +39282,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39131,6 +39413,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39238,6 +39521,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39272,6 +39561,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39291,12 +39581,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -39352,6 +39643,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39388,6 +39680,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -39484,6 +39777,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39614,6 +39908,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39721,6 +40016,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39755,6 +40056,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39774,11 +40076,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -39965,6 +40268,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40094,6 +40398,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40201,6 +40506,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40235,6 +40546,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40254,12 +40566,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -40314,6 +40627,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40350,6 +40664,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40445,6 +40760,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40573,6 +40889,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40680,6 +40997,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40714,6 +41037,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40733,6 +41057,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -40849,7 +41174,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -40925,6 +41253,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -41025,6 +41354,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41061,6 +41391,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -41156,6 +41487,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41287,6 +41619,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41394,6 +41727,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41428,6 +41767,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41447,11 +41787,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -41462,7 +41803,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -41649,6 +41990,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41779,6 +42121,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41886,6 +42229,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41920,6 +42269,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41939,11 +42289,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -41998,6 +42349,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42034,6 +42386,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -42129,6 +42482,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42257,6 +42611,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42364,6 +42719,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42398,6 +42759,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42417,6 +42779,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -42536,7 +42899,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -42612,6 +42978,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -42667,7 +43034,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -42682,7 +43049,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -42694,7 +43061,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -42750,6 +43117,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42786,6 +43154,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -42882,6 +43251,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43010,6 +43380,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43117,6 +43488,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -43151,6 +43528,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43170,11 +43548,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -43185,7 +43564,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -43196,7 +43575,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -43207,7 +43586,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -43233,34 +43612,24 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { /** @enum {string} */ action: "added"; changes?: { - /** - * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - * assigned to the collaborator, use the `role_name` field instead, which will provide the full - * role name, including custom roles. - */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; - /** @description The role assigned to the collaborator. */ - role_name?: { - to: string; - }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -43282,7 +43651,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -43293,7 +43662,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -43345,6 +43714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -43398,6 +43768,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -43482,7 +43853,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -43493,7 +43864,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -43504,7 +43875,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -43515,7 +43886,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -43541,7 +43912,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -43552,7 +43923,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -43563,7 +43934,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -43574,7 +43945,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -43629,6 +44000,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -43638,7 +44010,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -43650,7 +44022,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -43666,7 +44038,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -43740,6 +44112,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -43779,6 +44152,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -43916,6 +44290,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -43951,7 +44326,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -44006,6 +44381,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -44045,6 +44421,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -44116,6 +44493,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -44152,7 +44530,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -44200,6 +44578,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -44211,15 +44590,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { /** @enum {string} */ action: "approved"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -44227,8 +44607,9 @@ export interface components { /** @enum {string} */ action: "cancelled"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -44236,9 +44617,10 @@ export interface components { /** @enum {string} */ action: "created"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ "webhook-personal-access-token-request-denied": { @@ -44246,7 +44628,8 @@ export interface components { action: "denied"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -44293,7 +44676,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -44316,7 +44699,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -44327,7 +44710,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -44384,6 +44767,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -44397,7 +44781,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -44413,7 +44797,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -44474,6 +44858,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -44519,7 +44904,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -44530,7 +44915,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -44541,7 +44926,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -44552,7 +44937,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -44568,7 +44953,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -44579,7 +44964,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -44590,7 +44975,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -44601,7 +44986,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -44623,7 +45008,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -44634,7 +45019,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -44643,7 +45028,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -44652,7 +45037,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -44661,7 +45046,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -44688,7 +45073,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -44698,7 +45083,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -44713,7 +45098,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -44722,7 +45107,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -44731,12 +45116,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { @@ -44756,7 +45145,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -44771,7 +45160,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -44781,7 +45170,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -44790,7 +45179,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -44798,7 +45187,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -44897,6 +45286,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44933,6 +45323,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44993,6 +45384,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -45120,7 +45512,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -45213,6 +45608,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45276,7 +45672,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -45305,6 +45701,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45324,6 +45721,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -45463,7 +45861,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -45556,6 +45957,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45619,7 +46021,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -45648,6 +46050,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45667,6 +46070,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -45734,6 +46138,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -45781,6 +46186,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45849,6 +46255,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -45989,6 +46396,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46008,10 +46416,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -46109,6 +46518,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46205,6 +46615,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -46332,7 +46743,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46425,6 +46839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46488,7 +46903,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46517,6 +46932,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46536,6 +46952,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -46675,7 +47092,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46768,6 +47188,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46831,7 +47252,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46860,6 +47281,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46879,6 +47301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -46946,6 +47369,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -46993,6 +47417,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47061,6 +47486,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -47201,6 +47627,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47220,11 +47647,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -47322,6 +47750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47418,6 +47847,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -47545,7 +47975,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47638,6 +48071,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47701,7 +48135,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47730,6 +48164,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47749,6 +48184,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -47981,6 +48417,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48044,7 +48481,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48073,6 +48510,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48092,6 +48530,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -48159,6 +48598,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -48206,6 +48646,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48274,6 +48715,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -48414,6 +48856,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48433,11 +48876,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -48449,7 +48893,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -48461,7 +48905,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -48473,7 +48917,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -48504,7 +48948,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -48603,6 +49047,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48699,6 +49144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48826,7 +49272,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48919,6 +49368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48982,7 +49432,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49011,6 +49461,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49030,6 +49481,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -49169,7 +49621,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49262,6 +49717,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49325,7 +49781,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49354,6 +49810,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49373,6 +49830,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -49440,6 +49898,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -49487,6 +49946,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49555,6 +50015,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -49695,6 +50156,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49714,10 +50176,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -49815,6 +50278,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49911,6 +50375,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -50038,7 +50503,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50131,6 +50599,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50194,7 +50663,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50223,6 +50692,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50242,6 +50712,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -50381,7 +50852,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50474,6 +50948,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50537,7 +51012,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50566,6 +51041,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50585,6 +51061,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50652,6 +51129,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -50699,6 +51177,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50767,6 +51246,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50907,6 +51387,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50926,10 +51407,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -50941,7 +51423,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -50953,7 +51435,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -50965,7 +51447,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -50977,7 +51459,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -51115,6 +51597,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51134,6 +51617,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -51225,6 +51709,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -51321,6 +51806,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -51448,7 +51934,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51541,6 +52030,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51604,7 +52094,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51633,6 +52123,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51652,6 +52143,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51784,7 +52276,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51877,6 +52372,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51940,7 +52436,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51969,6 +52465,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51988,6 +52485,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -52059,6 +52557,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -52125,6 +52624,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -52259,6 +52759,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52278,10 +52779,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -52377,6 +52879,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52473,6 +52976,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52600,7 +53104,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52693,6 +53200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52756,7 +53264,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52785,6 +53293,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52804,6 +53313,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52936,7 +53446,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53029,6 +53542,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53092,7 +53606,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53121,6 +53635,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53140,6 +53655,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -53211,6 +53727,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53277,6 +53794,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53411,6 +53929,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53430,10 +53949,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -53530,6 +54050,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53566,6 +54087,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -53626,6 +54148,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53753,7 +54276,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53846,6 +54372,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53909,7 +54436,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53938,6 +54465,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53957,6 +54485,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -54089,7 +54618,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54182,6 +54714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54245,7 +54778,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54274,6 +54807,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54293,6 +54827,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54364,6 +54899,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54430,6 +54966,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -54564,6 +55101,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54581,12 +55119,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -54682,6 +55221,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54778,6 +55318,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54905,7 +55446,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54998,6 +55542,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55061,7 +55606,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55090,6 +55635,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55109,6 +55655,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55241,7 +55788,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55334,6 +55884,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55397,7 +55948,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55426,6 +55977,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55445,6 +55997,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55516,6 +56069,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55582,6 +56136,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -55716,6 +56271,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55735,6 +56291,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -55798,6 +56355,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55817,9 +56375,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -55921,6 +56480,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56017,6 +56577,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56139,7 +56700,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56215,6 +56779,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56280,6 +56845,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56299,6 +56865,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56426,7 +56993,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56502,6 +57072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56567,6 +57138,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56586,6 +57158,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56657,6 +57230,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56723,6 +57297,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56857,6 +57432,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56876,11 +57452,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -56981,6 +57558,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57017,6 +57595,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -57077,6 +57656,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57204,7 +57784,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57297,6 +57880,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57353,7 +57937,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57382,6 +57966,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57401,6 +57986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -57540,7 +58126,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57633,6 +58222,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57696,7 +58286,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57725,6 +58315,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57744,6 +58335,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57811,6 +58403,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57858,6 +58451,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57926,6 +58520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -58066,6 +58661,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58085,6 +58681,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -58124,8 +58721,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -58223,6 +58821,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58259,6 +58858,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -58319,6 +58919,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -58446,7 +59047,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58539,6 +59143,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58602,7 +59207,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58631,6 +59236,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58650,6 +59256,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58789,7 +59396,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58882,6 +59492,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58945,7 +59556,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58974,6 +59585,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58993,6 +59605,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59060,6 +59673,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -59107,6 +59721,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59175,6 +59790,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -59315,6 +59931,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59334,6 +59951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -59392,7 +60010,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -59495,6 +60113,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59531,6 +60150,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -59591,6 +60211,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59718,7 +60339,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59811,6 +60435,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59874,7 +60499,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -59903,6 +60528,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59922,6 +60548,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -60061,7 +60688,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60154,6 +60784,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60217,7 +60848,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60246,6 +60877,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60265,6 +60897,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60332,6 +60965,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -60379,6 +61013,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60447,6 +61082,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -60587,6 +61223,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60606,6 +61243,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -60645,8 +61283,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -60744,6 +61383,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60780,6 +61420,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -60840,6 +61481,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60967,7 +61609,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61060,6 +61705,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61123,7 +61769,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61152,6 +61798,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61171,6 +61818,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61310,7 +61958,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61403,6 +62054,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61466,7 +62118,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61495,6 +62147,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61514,6 +62167,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61581,6 +62235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -61628,6 +62283,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61696,6 +62352,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61836,6 +62493,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61855,6 +62513,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -61913,7 +62572,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -62011,6 +62670,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -62107,6 +62767,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62234,7 +62895,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62327,6 +62991,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62390,7 +63055,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62419,6 +63084,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62438,6 +63104,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62570,7 +63237,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62663,6 +63333,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62726,7 +63397,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62755,6 +63426,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62774,6 +63446,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62845,6 +63518,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62911,6 +63585,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -63045,6 +63720,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63064,11 +63740,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -63164,6 +63841,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63260,6 +63938,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63387,7 +64066,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63463,6 +64145,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63530,6 +64213,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63549,6 +64233,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63681,7 +64366,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63757,6 +64445,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63824,6 +64513,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63843,6 +64533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63914,6 +64605,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63980,6 +64672,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -64114,6 +64807,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64133,10 +64827,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -64266,6 +64961,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64285,6 +64981,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -64384,6 +65081,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64480,6 +65178,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64607,7 +65306,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64683,6 +65385,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64750,6 +65453,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64769,6 +65473,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64901,7 +65606,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64977,6 +65685,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65044,6 +65753,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65063,6 +65773,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65134,6 +65845,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65200,6 +65912,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -65334,6 +66047,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65353,10 +66067,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -65486,6 +66201,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65505,6 +66221,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -65608,6 +66325,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65704,6 +66422,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65831,7 +66550,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65924,6 +66646,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65987,7 +66710,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66016,6 +66739,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66035,6 +66759,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66174,7 +66899,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66260,6 +66988,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66323,7 +67052,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66352,6 +67081,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66371,6 +67101,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66438,6 +67169,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -66485,6 +67217,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66553,6 +67286,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -66693,6 +67427,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66712,10 +67447,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -66814,6 +67550,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66910,6 +67647,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67037,7 +67775,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67130,6 +67871,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67193,7 +67935,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -67222,6 +67964,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67241,6 +67984,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67380,7 +68124,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67473,6 +68220,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67536,7 +68284,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -67565,6 +68313,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67584,6 +68333,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67651,6 +68401,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -67698,6 +68449,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67766,6 +68518,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67906,6 +68659,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67925,10 +68679,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -68027,6 +68782,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -68123,6 +68879,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68250,7 +69007,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68343,6 +69103,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68406,7 +69167,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68435,6 +69196,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68454,6 +69216,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68593,7 +69356,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68679,6 +69445,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68742,7 +69509,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68771,6 +69538,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68790,6 +69558,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68857,6 +69626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -68904,6 +69674,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68972,6 +69743,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -69112,6 +69884,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69131,10 +69904,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -69232,6 +70006,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69328,6 +70103,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69455,7 +70231,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69548,6 +70327,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69611,7 +70391,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69640,6 +70420,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69659,6 +70440,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -69798,7 +70580,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69891,6 +70676,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69954,7 +70740,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69983,6 +70769,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70002,6 +70789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -70069,6 +70857,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -70116,6 +70905,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70184,6 +70974,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -70324,6 +71115,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70343,10 +71135,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -70600,7 +71393,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70676,6 +71472,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70725,7 +71522,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -70760,6 +71557,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -70782,6 +71580,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -70900,6 +71699,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -70930,7 +71730,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -70965,6 +71765,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -70987,6 +71788,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -71039,6 +71841,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -71063,7 +71866,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -71074,7 +71877,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -71085,7 +71888,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -71110,7 +71913,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -71222,6 +72025,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -71270,7 +72074,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -71281,7 +72085,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -71292,7 +72096,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -71303,7 +72107,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-disabled": { /** @enum {string} */ @@ -71312,7 +72116,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-enabled": { /** @enum {string} */ @@ -71321,7 +72125,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -71331,7 +72135,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -71341,7 +72145,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -71351,7 +72155,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -71366,7 +72170,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -71390,7 +72194,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository privatized event */ "webhook-repository-privatized": { @@ -71400,7 +72204,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -71410,7 +72214,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -71427,7 +72231,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -71438,7 +72242,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -71449,7 +72253,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -71507,7 +72311,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -71558,6 +72362,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71577,6 +72382,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -71585,7 +72391,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -71595,7 +72401,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -71606,7 +72412,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -71659,6 +72465,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -71679,7 +72486,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -71690,7 +72497,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -71762,7 +72569,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -71773,7 +72580,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -71784,7 +72591,7 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { @@ -71800,7 +72607,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -71811,18 +72618,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { - /** @enum {string} */ - action: "revoked"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - 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"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -71833,7 +72629,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -71844,7 +72640,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -71860,6 +72656,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -71891,7 +72688,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -71904,7 +72701,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -71914,7 +72711,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -71925,7 +72722,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -71942,7 +72739,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -71954,7 +72751,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -71967,7 +72764,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -71979,7 +72776,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -71990,7 +72787,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -72002,7 +72799,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -72181,7 +72978,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -72199,7 +72996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -72321,7 +73118,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72397,6 +73197,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72444,7 +73245,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -72566,7 +73367,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72642,6 +73446,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72689,7 +73494,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -72811,7 +73616,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72887,6 +73695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72934,7 +73743,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -73087,7 +73896,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73163,6 +73975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73210,7 +74023,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -73332,7 +74145,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73408,6 +74224,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73455,7 +74272,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; "webhook-user-created": { @@ -73465,7 +74282,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; "webhook-user-deleted": { @@ -73475,7 +74292,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** watch started event */ @@ -73486,7 +74303,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -73498,7 +74315,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -73509,7 +74326,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -73614,7 +74431,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -73712,7 +74529,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -73766,7 +74583,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -73825,7 +74642,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -73865,6 +74682,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -73884,6 +74702,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -74024,6 +74843,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -74198,6 +75018,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -74272,6 +75093,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -74295,7 +75117,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -74759,7 +75581,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -74799,6 +75621,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -74959,6 +75782,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -75133,6 +75957,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -75207,6 +76032,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -75550,11 +76376,7 @@ export interface components { "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.12/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ + /** @description A comma-separated list of secret types to return. By default all secret types are returned. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.12/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution"?: string; @@ -75581,8 +76403,6 @@ export interface components { "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: string; - /** @description Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too. */ - "license-apply"?: boolean; /** @description The UUID which identifies a node. */ uuid?: string; /** @description The cluster roles from the cluster configuration file. */ @@ -75617,6 +76437,10 @@ export interface components { "role-id": number; /** @description The unique identifier of the group. */ "group-id": number; + /** @description The number of results per page for the "members" array (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-per-page"?: number; + /** @description The page number of the "members" array results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-page"?: number; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ @@ -75654,8 +76478,16 @@ 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 name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query"?: number; + /** + * @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + */ + "ruleset-targets"?: string; + /** @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 name of the repository to filter on. */ + "repository-name-in-query"?: string; /** * @description The time period to filter by. * @@ -75824,8 +76656,6 @@ 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 A repository ID. Only return repositories with an ID greater than this ID. */ @@ -75852,6 +76682,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred"?: "created" | "updated"; + /** @description account_id parameter */ + "account-id": number; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user"?: number; }; @@ -76754,13 +77586,23 @@ export interface operations { * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.12/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** + * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; direction?: components["parameters"]["direction"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; }; responses: { @@ -76895,7 +77737,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -77463,8 +78304,6 @@ export interface operations { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/enterprise-server@3.12/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/create-installation-access-token": { @@ -77545,7 +78384,8 @@ export interface operations { /** * List your grants * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.12/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ @@ -77577,7 +78417,8 @@ export interface operations { /** * Get a single grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ "oauth-authorizations/get-grant": { parameters: { @@ -77600,7 +78441,8 @@ export interface operations { /** * Delete a grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -77622,7 +78464,7 @@ export interface operations { }; /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ "apps/delete-authorization": { @@ -77649,7 +78491,7 @@ export interface operations { }; /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -77678,7 +78520,7 @@ export interface operations { }; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -77704,7 +78546,7 @@ export interface operations { }; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -77737,10 +78579,6 @@ export interface operations { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ "apps/scope-token": { parameters: { @@ -77794,7 +78632,8 @@ export interface operations { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ "apps/get-by-slug": { parameters: { @@ -77816,7 +78655,8 @@ export interface operations { /** * List your authorizations * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ "oauth-authorizations/list-authorizations": { parameters: { @@ -77846,11 +78686,13 @@ export interface operations { /** * Create a new authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.12/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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.12/rest/authentication/authenticating-to-the-rest-api#using-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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * @@ -77907,15 +78749,15 @@ export interface operations { /** * Get-or-create an authorization for a specific app * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * * 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ "oauth-authorizations/get-or-create-authorization-for-app": { parameters: { @@ -77959,7 +78801,10 @@ export interface operations { "application/json": components["schemas"]["authorization"]; }; }; - /** @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ + /** + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + */ 201: { headers: { /** @example https://api.github.com/authorizations/1 */ @@ -77978,9 +78823,11 @@ export interface operations { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.12/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * @@ -78043,7 +78890,8 @@ export interface operations { /** * Get a single authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ "oauth-authorizations/get-authorization": { parameters: { @@ -78066,7 +78914,8 @@ export interface operations { /** * Delete an authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). */ "oauth-authorizations/delete-authorization": { parameters: { @@ -78087,7 +78936,8 @@ export interface operations { /** * Update an existing authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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.12/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.12/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/). * * 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.12/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * @@ -79648,7 +80498,8 @@ export interface operations { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-public-events": { parameters: { @@ -79683,7 +80534,8 @@ export interface operations { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.12/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -79725,7 +80577,8 @@ export interface operations { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ "gists/create": { requestBody: { @@ -80336,10 +81189,8 @@ export interface operations { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -80541,15 +81392,59 @@ export interface operations { }; }; /** - * Get the GHES settings - * @description Gets a list of settings for a GitHub Enterprise Server instance. + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. */ - "enterprise-admin/get-manage-settings": { + "enterprise-admin/get-cluster-status": { responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["ghes-get-settings"]; + "application/json": components["schemas"]["ghes-cluster-status"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + "enterprise-admin/get-manage-config-apply-status": { + parameters: { + query?: { + /** @description The unique run ID of the `ghe-config-apply` run. */ + run_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Whether the ghe-config-apply run is still running in the environment */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful in the environment */ + successful?: boolean; + nodes?: { + /** @description The unique Run ID of the ghe-config-apply run on the host */ + run_id?: string; + /** @description The hostname of the node */ + hostname?: string; + /** @description Whether the ghe-config-apply run is still running on the host */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful on the host */ + successful?: boolean; + }[]; + }; }; }; /** @description Bad request */ @@ -80563,14 +81458,98 @@ export interface operations { }; }; /** - * Initialize instance configuration with license upload - * @description When you boot a GitHub instance for the first time, you can use this endpoint to upload a license. + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + "enterprise-admin/post-manage-run-config-apply": { + requestBody?: { + content: { + "application/json": { + /** @description The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly. */ + run_id?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Run ID the job was launched with */ + run_id?: string; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + "enterprise-admin/get-manage-config-apply-events": { + parameters: { + query?: { + /** @description The unique ID of the last response from a host, used for pagination. */ + last_request_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + nodes?: { + /** @description Hostname of the node */ + node?: string; + /** @description Unique ID of the last response from a host used for pagination */ + last_request_id?: string; + events?: { + timestamp?: string; + severity_text?: string; + body?: string; + event_name?: string; + topology?: string; + hostname?: string; + config_run_id?: string; + trace_id?: string; + span_id?: string; + span_parent_id?: string; + span_depth?: number; + }[]; + }[]; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. * - * Note that you afterwards need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) to start the actual configuration process. + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) * - * This endpoint also sets the root site administrator password which is used to authenticate with the GHES Manage API and the Management Console. + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/initialize-instance-configuration": { requestBody: { @@ -80621,14 +81600,12 @@ export interface operations { }; /** * Upload an enterprise license - * @description Uploads an enterprise license. This operation does not automatically activate the license. + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/license-upload": { - parameters: { - query?: { - apply?: components["parameters"]["license-apply"]; - }; - }; requestBody: { content: { "application/octet-stream": string; @@ -80704,6 +81681,28 @@ export interface operations { }; }; }; + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + "enterprise-admin/get-manage-settings": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-settings"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; /** * Set settings * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/manage-ghes#get-settings). @@ -80929,7 +81928,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-repo-network": { parameters: { query?: { @@ -81168,7 +82171,8 @@ export interface operations { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ "orgs/list": { parameters: { @@ -81192,10 +82196,10 @@ export interface operations { }; }; /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.12/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * @@ -81234,17 +82238,6 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -81289,21 +82282,11 @@ export interface operations { }; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.12/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -81354,7 +82337,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -81376,7 +82359,7 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -81384,7 +82367,7 @@ export interface operations { */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @description Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -81392,7 +82375,7 @@ export interface operations { */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @description Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -81400,7 +82383,7 @@ export interface operations { */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -81408,7 +82391,7 @@ export interface operations { */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -81416,7 +82399,7 @@ export interface operations { */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -83795,7 +84778,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-org-events": { parameters: { query?: { @@ -83823,6 +84810,10 @@ export interface operations { */ "teams/external-idp-group-info-for-org": { parameters: { + query?: { + per_page?: components["parameters"]["members-per-page"]; + page?: components["parameters"]["members-page"]; + }; path: { org: components["parameters"]["org"]; group_id: components["parameters"]["group-id"]; @@ -83871,7 +84862,9 @@ export interface operations { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -83989,7 +84982,9 @@ export interface operations { }; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -84141,7 +85136,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -84294,10 +85288,8 @@ export interface operations { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -84456,7 +85448,7 @@ export interface operations { * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ "orgs/set-membership-for-user": { parameters: { @@ -84837,7 +85829,7 @@ export interface operations { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-organization": { parameters: { @@ -84876,7 +85868,7 @@ export interface operations { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-organization": { parameters: { @@ -84901,7 +85893,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-org": { parameters: { @@ -84931,7 +85923,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-org": { parameters: { @@ -84959,7 +85951,7 @@ export interface operations { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { @@ -84991,7 +85983,7 @@ export interface operations { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-organization": { parameters: { @@ -85017,7 +86009,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-org": { parameters: { @@ -85048,7 +86040,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-org": { parameters: { @@ -85595,7 +86587,8 @@ export interface operations { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/list-for-org": { parameters: { @@ -85728,12 +86721,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -85750,7 +86745,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -85820,6 +86817,7 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; }; path: { org: components["parameters"]["org"]; @@ -85854,6 +86852,7 @@ export interface operations { name: string; /** * @description The target of the ruleset. + * @default branch * @enum {string} */ target?: "branch" | "tag"; @@ -85863,6 +86862,11 @@ export interface operations { conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ rules?: components["schemas"]["repository-rule"][]; + /** + * @description The type of the source of the ruleset + * @enum {string} + */ + source_type?: "Repository" | "Organization"; }; }; }; @@ -85885,6 +86889,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + ref?: components["parameters"]["ref-in-query"]; repository_name?: components["parameters"]["repository-name-in-query"]; time_period?: components["parameters"]["time-period"]; actor_name?: components["parameters"]["actor-name-in-query"]; @@ -85933,6 +86938,9 @@ export interface operations { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-org-ruleset": { parameters: { @@ -86231,7 +87239,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -86258,7 +87266,8 @@ export interface operations { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ "teams/get-by-name": { parameters: { @@ -86283,7 +87292,8 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ "teams/delete-in-org": { parameters: { @@ -86303,7 +87313,8 @@ export interface operations { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ "teams/update-in-org": { parameters: { @@ -86339,7 +87350,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -86371,7 +87382,8 @@ export interface operations { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -86405,9 +87417,10 @@ export interface operations { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86446,7 +87459,8 @@ export interface operations { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -86471,7 +87485,8 @@ export interface operations { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86494,7 +87509,8 @@ export interface operations { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86529,7 +87545,8 @@ export interface operations { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -86562,9 +87579,10 @@ export interface operations { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86597,7 +87615,8 @@ export interface operations { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -86623,7 +87642,8 @@ export interface operations { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86647,7 +87667,8 @@ export interface operations { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86681,7 +87702,8 @@ export interface operations { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -86726,7 +87748,8 @@ export interface operations { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86775,7 +87798,8 @@ export interface operations { }; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -86802,7 +87826,8 @@ export interface operations { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -86846,7 +87871,8 @@ export interface operations { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -86894,7 +87920,8 @@ export interface operations { }; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * @@ -87028,10 +88055,11 @@ export interface operations { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#create-a-team). */ @@ -87062,13 +88090,15 @@ export interface operations { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -87113,9 +88143,11 @@ export interface operations { * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -87140,7 +88172,8 @@ export interface operations { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ "teams/list-projects-in-org": { parameters: { @@ -87169,7 +88202,8 @@ export interface operations { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -87196,7 +88230,8 @@ export interface operations { * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -87237,7 +88272,8 @@ export interface operations { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/remove-project-in-org": { parameters: { @@ -87258,7 +88294,8 @@ export interface operations { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ "teams/list-repos-in-org": { parameters: { @@ -87287,13 +88324,14 @@ export interface operations { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/check-permissions-for-repo-in-org": { parameters: { @@ -87325,7 +88363,8 @@ export interface operations { * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.12/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -87341,10 +88380,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -87360,7 +88396,8 @@ export interface operations { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/remove-repo-in-org": { parameters: { @@ -87382,7 +88419,8 @@ export interface operations { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ "teams/list-child-in-org": { parameters: { @@ -87413,7 +88451,7 @@ export interface operations { * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -88103,7 +89141,8 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -88114,9 +89153,10 @@ export interface operations { * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.12/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.12/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.12/rest/overview/api-versions)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.12/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { responses: { @@ -88139,7 +89179,8 @@ export interface operations { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.12/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/get": { parameters: { @@ -88301,12 +89342,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -88323,7 +89366,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -89401,7 +90446,7 @@ export interface operations { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs-for-repo": { parameters: { @@ -89671,8 +90716,8 @@ export interface operations { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -90396,6 +91441,8 @@ export interface operations { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs": { parameters: { @@ -90668,13 +91715,13 @@ export interface operations { }; }; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { content: never; }; @@ -90684,7 +91731,7 @@ export interface operations { "repos/list-branches": { parameters: { query?: { - /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -90755,9 +91802,11 @@ export interface operations { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ "repos/update-branch-protection": { parameters: { @@ -90776,7 +91825,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -90998,7 +92047,8 @@ export interface operations { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ "repos/update-pull-request-review-protection": { parameters: { @@ -91059,7 +92109,8 @@ export interface operations { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.12/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ "repos/get-commit-signature-protection": { parameters: { @@ -91187,7 +92238,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -91333,7 +92384,8 @@ export interface operations { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ "repos/get-access-restrictions": { parameters: { @@ -91412,7 +92464,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -91444,7 +92496,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -91476,7 +92528,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -91656,7 +92708,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -91692,7 +92744,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -91728,7 +92780,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -91750,7 +92802,8 @@ export interface operations { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.12/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -91907,7 +92960,8 @@ export interface operations { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -91932,7 +92986,8 @@ export interface operations { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -92134,7 +93189,8 @@ export interface operations { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.12/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.12/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -92209,7 +93265,8 @@ export interface operations { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -92234,7 +93291,8 @@ export interface operations { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -92441,8 +93499,8 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -92711,6 +93769,8 @@ export interface operations { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -92893,7 +93953,7 @@ export interface operations { }; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.12/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -92960,7 +94020,8 @@ export interface operations { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -93216,7 +94277,8 @@ export interface operations { }; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.12/rest/commits/comments#get-a-commit-comment). */ @@ -93248,6 +94310,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -93278,8 +94341,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - since?: components["parameters"]["since"]; - /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -93369,7 +94433,7 @@ export interface operations { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -93395,7 +94459,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -93450,7 +94514,8 @@ export interface operations { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -93468,6 +94533,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -93517,7 +94583,8 @@ export interface operations { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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.12/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.12/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * @@ -93559,7 +94626,8 @@ export interface operations { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -93679,7 +94747,7 @@ export interface operations { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/using-pagination-in-the-rest-api)." @@ -93694,6 +94762,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -93792,6 +94861,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -93800,7 +94870,8 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -93859,7 +94930,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -93873,7 +94951,8 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.12/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -93977,7 +95056,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -94585,7 +95664,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -94670,7 +95752,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -94723,7 +95805,8 @@ export interface operations { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -94750,9 +95833,11 @@ export interface operations { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -95036,7 +96121,9 @@ export interface operations { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.12/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -95431,7 +96518,8 @@ export interface operations { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-repo-events": { parameters: { @@ -95484,9 +96572,11 @@ export interface operations { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ "repos/create-fork": { parameters: { @@ -95555,7 +96645,14 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** @@ -95604,6 +96701,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95637,7 +96735,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -95700,6 +96798,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95744,7 +96843,8 @@ export interface operations { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -95773,7 +96873,8 @@ export interface operations { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ "git/get-ref": { parameters: { @@ -95901,6 +97002,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95983,6 +97085,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -96097,8 +97200,8 @@ export interface operations { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ "git/get-tree": { parameters: { @@ -96230,7 +97333,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -96358,7 +97466,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -96444,7 +97551,8 @@ export interface operations { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ "repos/test-push-webhook": { parameters: { @@ -96562,10 +97670,8 @@ export interface operations { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -96619,7 +97725,7 @@ export interface operations { * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.12/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -96643,7 +97749,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: string | number | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -96897,7 +98003,8 @@ export interface operations { }; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.12/rest/issues/comments#get-an-issue-comment). */ @@ -96978,10 +98085,8 @@ export interface operations { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/enterprise-server@3.12/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -97013,7 +98118,7 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -97037,7 +98142,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -97217,7 +98322,7 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -97601,7 +98706,8 @@ export interface operations { }; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.12/rest/issues/issues#get-an-issue). */ @@ -98366,7 +99472,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.12/articles/using-a-custom-domain-with-github-pages/)." */ + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.12/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -98839,7 +99945,7 @@ export interface operations { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -99112,7 +100218,8 @@ export interface operations { }; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.12/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -99148,7 +100255,7 @@ export interface operations { * * If merged via a [squash](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * * If [rebased](https://docs.github.com/enterprise-server@3.12/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -99167,7 +100274,7 @@ export interface operations { }; }; responses: { - /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ + /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -99277,9 +100384,9 @@ export interface operations { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -99308,7 +100415,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -99357,7 +100464,7 @@ export interface operations { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -99439,8 +100546,8 @@ export interface operations { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -99502,7 +100609,7 @@ export interface operations { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." */ "pulls/merge": { parameters: { @@ -99690,11 +100797,12 @@ export interface operations { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -99896,9 +101004,8 @@ export interface operations { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.12/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.12/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -99988,6 +101095,7 @@ export interface operations { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -100046,6 +101154,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -100117,7 +101226,7 @@ export interface operations { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." */ "repos/create-release": { parameters: { @@ -100177,7 +101286,13 @@ export interface operations { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ "repos/get-release-asset": { parameters: { @@ -100331,9 +101446,8 @@ export interface operations { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ "repos/get-release": { parameters: { @@ -100569,7 +101683,8 @@ export interface operations { }; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.12/rest/releases/releases#get-a-release). */ @@ -100666,6 +101781,7 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; }; path: { owner: components["parameters"]["owner"]; @@ -100702,6 +101818,7 @@ export interface operations { name: string; /** * @description The target of the ruleset. + * @default branch * @enum {string} */ target?: "branch" | "tag"; @@ -100783,6 +101900,9 @@ export interface operations { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-repo-ruleset": { parameters: { @@ -101364,8 +102484,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -101388,8 +102512,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -101419,8 +102547,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.12/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -101445,7 +102577,9 @@ export interface operations { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -101531,7 +102665,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -101645,7 +102779,8 @@ export interface operations { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ "repos/download-zipball-archive": { parameters: { @@ -101749,7 +102884,8 @@ export interface operations { }; /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -101784,7 +102920,8 @@ export interface operations { }; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -101818,7 +102955,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ @@ -101849,7 +102987,8 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -101885,9 +103024,10 @@ export interface operations { }; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { @@ -101911,7 +103051,8 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -101953,7 +103094,8 @@ export interface operations { }; /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -101987,7 +103129,8 @@ export interface operations { }; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -102023,7 +103166,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ @@ -102051,13 +103195,15 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { @@ -102089,7 +103235,8 @@ export interface operations { }; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ @@ -102115,25 +103262,28 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { @@ -102264,7 +103414,8 @@ export interface operations { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.12/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.12/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ "search/issues-and-pull-requests": { parameters: { @@ -102531,7 +103682,8 @@ export interface operations { }; /** * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * @description > [!NOTE] + * > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ "enterprise-admin/enable-or-disable-maintenance-mode": { requestBody: { @@ -102565,7 +103717,8 @@ export interface operations { * Get settings * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.12/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * > [!NOTE] + * > You cannot retrieve the management console password with the Enterprise administration API. */ "enterprise-admin/get-settings": { responses: { @@ -102688,7 +103841,8 @@ export interface operations { * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/create-enterprise-server-license": { requestBody: { @@ -102718,7 +103872,8 @@ export interface operations { * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/upgrade-license": { requestBody?: { @@ -102743,7 +103898,8 @@ export interface operations { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#get-a-team-by-name) endpoint. */ "teams/get-legacy": { parameters: { @@ -102764,7 +103920,8 @@ export interface operations { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -102788,11 +103945,13 @@ export interface operations { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -102827,7 +103986,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -102858,7 +104017,8 @@ export interface operations { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -102890,11 +104050,12 @@ export interface operations { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -102931,7 +104092,8 @@ export interface operations { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -102956,7 +104118,8 @@ export interface operations { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -102979,7 +104142,8 @@ export interface operations { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -103014,7 +104178,8 @@ export interface operations { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -103047,11 +104212,12 @@ export interface operations { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.12/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.12/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -103082,7 +104248,8 @@ export interface operations { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -103108,7 +104275,8 @@ export interface operations { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -103132,7 +104300,8 @@ export interface operations { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -103166,7 +104335,8 @@ export interface operations { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -103209,7 +104379,8 @@ export interface operations { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.12/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -103256,7 +104427,8 @@ export interface operations { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * @@ -103298,7 +104470,8 @@ export interface operations { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.12/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.12/rest/teams/discussions#get-a-discussion). * @@ -103344,7 +104517,8 @@ export interface operations { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.12/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.12/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -103376,7 +104550,7 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -103403,7 +104577,7 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -103411,7 +104585,8 @@ export interface operations { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -103441,7 +104616,7 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -103449,7 +104624,8 @@ export interface operations { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-member-legacy": { parameters: { @@ -103472,7 +104648,8 @@ export interface operations { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -103503,13 +104680,15 @@ export interface operations { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -103555,13 +104734,15 @@ export interface operations { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.12/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.12/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.12/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-membership-for-user-legacy": { parameters: { @@ -103584,7 +104765,8 @@ export interface operations { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -103614,7 +104796,8 @@ export interface operations { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -103641,7 +104824,8 @@ export interface operations { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -103684,7 +104868,8 @@ export interface operations { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -103707,7 +104892,8 @@ export interface operations { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-team-repositories) endpoint. */ "teams/list-repos-legacy": { parameters: { @@ -103735,11 +104921,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -103769,7 +104957,8 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -103806,7 +104995,8 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -103828,7 +105018,8 @@ export interface operations { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.12/rest/teams/teams#list-child-teams) endpoint. */ "teams/list-child-legacy": { parameters: { @@ -104130,6 +105321,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -104335,6 +105527,8 @@ export interface operations { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -104356,6 +105550,8 @@ export interface operations { /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -104382,10 +105578,8 @@ export interface operations { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.12/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -104790,6 +105984,9 @@ export interface operations { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -104817,7 +106014,7 @@ export interface operations { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-authenticated-user": { parameters: { @@ -104849,7 +106046,7 @@ export interface operations { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-authenticated-user": { parameters: { @@ -104871,7 +106068,7 @@ export interface operations { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-authenticated-user": { parameters: { @@ -104898,7 +106095,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-authenticated-user": { parameters: { @@ -104925,7 +106122,7 @@ export interface operations { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { @@ -104956,7 +106153,7 @@ export interface operations { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-authenticated-user": { parameters: { @@ -104981,7 +106178,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-authenticated-user": { parameters: { @@ -105009,7 +106206,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-authenticated-user": { parameters: { @@ -105233,7 +106430,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -105250,7 +106449,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -105724,6 +106925,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.12/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.12/rest/users/emails)". + */ + "users/get-by-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. @@ -105802,7 +107029,10 @@ export interface operations { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-events-for-authenticated-user": { parameters: { @@ -105826,6 +107056,9 @@ export interface operations { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-org-events-for-authenticated-user": { parameters: { @@ -105847,7 +107080,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-user": { parameters: { query?: { @@ -106102,7 +107339,7 @@ export interface operations { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-user": { parameters: { @@ -106139,7 +107376,7 @@ export interface operations { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-user": { parameters: { @@ -106164,7 +107401,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-user": { parameters: { @@ -106194,7 +107431,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-user": { parameters: { @@ -106222,7 +107459,7 @@ export interface operations { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { @@ -106248,7 +107485,7 @@ export interface operations { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-user": { parameters: { @@ -106274,7 +107511,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-user": { parameters: { @@ -106305,7 +107542,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.12/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-user": { parameters: { @@ -106357,7 +107594,11 @@ export interface operations { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-received-events-for-user": { parameters: { @@ -106378,7 +107619,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-received-public-events-for-user": { parameters: { query?: { @@ -106711,4 +107956,34 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-organization-fine-grained-permissions": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; } diff --git a/packages/openapi-types-ghes-3.10/LICENSE b/packages/openapi-types-ghes-3.13/LICENSE similarity index 100% rename from packages/openapi-types-ghes-3.10/LICENSE rename to packages/openapi-types-ghes-3.13/LICENSE diff --git a/packages/openapi-types-ghes-3.11/README.md b/packages/openapi-types-ghes-3.13/README.md similarity index 72% rename from packages/openapi-types-ghes-3.11/README.md rename to packages/openapi-types-ghes-3.13/README.md index 520dda7a3..2182878c9 100644 --- a/packages/openapi-types-ghes-3.11/README.md +++ b/packages/openapi-types-ghes-3.13/README.md @@ -1,13 +1,13 @@ -# @octokit/openapi-types-ghes-3.11 +# @octokit/openapi-types-ghes-3.13 -> Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.11 +> Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.13 This package is continuously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/) ## Usage ```ts -import { components } from "@octokit/openapi-types-ghes-3.11"; +import { components } from "@octokit/openapi-types-ghes-3.13"; type Repository = components["schemas"]["full-repository"]; ``` diff --git a/packages/openapi-types-ghes-3.10/package.json b/packages/openapi-types-ghes-3.13/package.json similarity index 71% rename from packages/openapi-types-ghes-3.10/package.json rename to packages/openapi-types-ghes-3.13/package.json index a238c3a7b..84afe120e 100644 --- a/packages/openapi-types-ghes-3.10/package.json +++ b/packages/openapi-types-ghes-3.13/package.json @@ -1,10 +1,10 @@ { - "name": "@octokit/openapi-types-ghes-3.10", - "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.10", + "name": "@octokit/openapi-types-ghes-3.13", + "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.13", "repository": { "type": "git", "url": "https://github.com/octokit/openapi-types.ts.git", - "directory": "packages/openapi-types-ghes-3.10" + "directory": "packages/openapi-types-ghes-3.13" }, "publishConfig": { "access": "public", @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.6.0" + "openapi-version": "17.1.0" } } diff --git a/packages/openapi-types-ghes-3.11/types.d.ts b/packages/openapi-types-ghes-3.13/types.d.ts similarity index 92% rename from packages/openapi-types-ghes-3.11/types.d.ts rename to packages/openapi-types-ghes-3.13/types.d.ts index 0cf1e0b91..02ba6a510 100644 --- a/packages/openapi-types-ghes-3.11/types.d.ts +++ b/packages/openapi-types-ghes-3.13/types.d.ts @@ -42,7 +42,7 @@ export interface paths { "/admin/hooks/{hook_id}/pings": { /** * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the webhook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) to be sent to the webhook. */ post: operations["enterprise-admin/ping-global-webhook"]; }; @@ -57,7 +57,7 @@ export interface paths { "/admin/ldap/teams/{team_id}/mapping": { /** * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. + * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ patch: operations["enterprise-admin/update-ldap-mapping-for-team"]; }; @@ -165,7 +165,7 @@ export interface paths { "/admin/users": { /** * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * @@ -176,7 +176,7 @@ export interface paths { "/admin/users/{username}": { /** * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#suspend-a-user) is often a better option. + * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#suspend-a-user) is often a better option. * * You can delete any user account except your own. */ @@ -195,7 +195,7 @@ export interface paths { * List global security advisories * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.13/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." */ get: operations["security-advisories/list-global-advisories"]; }; @@ -209,16 +209,16 @@ export interface paths { "/app": { /** * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; }; "/app-manifests/{code}/conversions": { /** * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; }; @@ -227,14 +227,14 @@ export interface paths { * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; }; @@ -243,7 +243,7 @@ export interface paths { * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; }; @@ -252,7 +252,7 @@ export interface paths { * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; }; @@ -261,7 +261,7 @@ export interface paths { * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; }; @@ -286,14 +286,14 @@ export interface paths { * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; }; @@ -306,9 +306,7 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; }; @@ -317,14 +315,14 @@ export interface paths { * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; }; @@ -332,9 +330,10 @@ export interface paths { /** * List your grants * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ get: operations["oauth-authorizations/list-grants"]; }; @@ -342,13 +341,15 @@ export interface paths { /** * Get a single grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ get: operations["oauth-authorizations/get-grant"]; /** * Delete a grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -357,7 +358,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; @@ -365,17 +366,17 @@ export interface paths { "/applications/{client_id}/token": { /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -387,17 +388,14 @@ export interface paths { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; }; @@ -405,23 +403,26 @@ export interface paths { /** * List your authorizations * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ get: operations["oauth-authorizations/list-authorizations"]; /** * Create a new authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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). * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.11/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.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * - * 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.11/articles/creating-an-access-token-for-command-line-use). + * 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.13/articles/creating-an-access-token-for-command-line-use). * - * 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.11/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. + * 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.13/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"]; }; @@ -429,15 +430,15 @@ export interface paths { /** * Get-or-create an authorization for a specific app * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * 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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; }; @@ -445,13 +446,15 @@ export interface paths { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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.11/rest/overview/other-authentication-methods#working-with-two-factor-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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; }; @@ -459,21 +462,24 @@ export interface paths { /** * Get a single authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ get: operations["oauth-authorizations/get-authorization"]; /** * Delete an authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ delete: operations["oauth-authorizations/delete-authorization"]; /** * Update an existing authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * 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.11/rest/overview/other-authentication-methods#working-with-two-factor-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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * You can only send one of these scope keys at a time. */ @@ -669,7 +675,7 @@ export interface paths { * Get default workflow permissions for an enterprise * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -678,7 +684,7 @@ export interface paths { * Set default workflow permissions for an enterprise * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets * whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -924,7 +930,7 @@ export interface paths { "/enterprises/{enterprise}/code-scanning/alerts": { /** * List code scanning alerts for an enterprise - * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be a member of the enterprise to use this endpoint. * @@ -959,7 +965,7 @@ export interface paths { * * The authenticated user must be a member of the enterprise to use this endpoint. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ @@ -969,7 +975,7 @@ export interface paths { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. */ get: operations["secret-scanning/list-alerts-for-enterprise"]; }; @@ -998,7 +1004,8 @@ export interface paths { "/events": { /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; }; @@ -1008,16 +1015,17 @@ export interface paths { * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -1031,7 +1039,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; }; @@ -1040,7 +1049,7 @@ export interface paths { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; }; @@ -1056,7 +1065,7 @@ export interface paths { * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1075,7 +1084,7 @@ export interface paths { * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1085,7 +1094,7 @@ export interface paths { * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1097,7 +1106,7 @@ export interface paths { * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1109,7 +1118,7 @@ export interface paths { * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1131,7 +1140,7 @@ export interface paths { get: operations["gists/check-is-starred"]; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; /** Unstar a gist */ @@ -1142,7 +1151,7 @@ export interface paths { * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1152,7 +1161,7 @@ export interface paths { "/gitignore/templates": { /** * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-for-the-authenticated-user). + * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; }; @@ -1161,7 +1170,7 @@ export interface paths { * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ @@ -1179,7 +1188,7 @@ export interface paths { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; }; @@ -1190,12 +1199,10 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -1207,33 +1214,139 @@ export interface paths { "/licenses": { /** * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; }; "/licenses/{license}": { /** * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; }; + "/manage/v1/access/ssh": { + /** + * Get the configured SSH keys + * @description Gets the configured SSH keys on all available nodes. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + get: operations["enterprise-admin/get-manage-ssh"]; + /** + * Set a new SSH key + * @description Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + post: operations["enterprise-admin/set-manage-ssh"]; + /** + * Delete a SSH key + * @description Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + delete: operations["enterprise-admin/delete-manage-ssh"]; + }; + "/manage/v1/checks/system-requirements": { + /** + * Get the system requirement check results for configured cluster nodes + * @description Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + * This endpoint may take several seconds to reply. + */ + get: operations["enterprise-admin/get-checks-system-requirements"]; + }; + "/manage/v1/cluster/status": { + /** + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. + */ + get: operations["enterprise-admin/get-cluster-status"]; + }; + "/manage/v1/config/apply": { + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + get: operations["enterprise-admin/get-manage-config-apply-status"]; + /** + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + post: operations["enterprise-admin/post-manage-run-config-apply"]; + }; + "/manage/v1/config/apply/events": { + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + get: operations["enterprise-admin/get-manage-config-apply-events"]; + }; + "/manage/v1/config/init": { + /** + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + * + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + * + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + post: operations["enterprise-admin/initialize-instance-configuration"]; + }; + "/manage/v1/config/license": { + /** + * Get the enterprise license information + * @description Gets information about the license that is currently set for the enterprise. + */ + get: operations["enterprise-admin/license-info"]; + /** + * Upload an enterprise license + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + put: operations["enterprise-admin/license-upload"]; + }; + "/manage/v1/config/license/check": { + /** + * Check a license + * @description Check the status of the license that is currently set for the enterprise. + */ + get: operations["enterprise-admin/license-check"]; + }; "/manage/v1/config/nodes": { /** * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.11/admin/enterprise-management/configuring-clustering/about-clustering)." + * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.13/admin/enterprise-management/configuring-clustering/about-clustering)." */ get: operations["enterprise-admin/get-config-nodes"]; }; + "/manage/v1/config/settings": { + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + get: operations["enterprise-admin/get-manage-settings"]; + /** + * Set settings + * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-settings). + * + * **Notes:** + * - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + * - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + */ + put: operations["enterprise-admin/set-manage-settings"]; + }; "/manage/v1/maintenance": { /** * Get the status of maintenance mode - * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ get: operations["enterprise-admin/get-manage-maintenance"]; /** * Set the status of maintenance mode - * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ post: operations["enterprise-admin/set-manage-maintenance"]; }; @@ -1248,7 +1361,7 @@ export interface paths { "/manage/v1/version": { /** * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.11/admin/all-releases)." + * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.13/admin/all-releases)." */ get: operations["enterprise-admin/get-version"]; }; @@ -1268,7 +1381,11 @@ export interface paths { get: operations["meta/get"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; }; "/notifications": { @@ -1279,7 +1396,7 @@ export interface paths { get: operations["activity/list-notifications-for-authenticated-user"]; /** * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; }; @@ -1289,6 +1406,11 @@ export interface paths { * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications. + */ + delete: operations["activity/mark-thread-as-done"]; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. @@ -1298,7 +1420,7 @@ export interface paths { "/notifications/threads/{thread_id}/subscription": { /** * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription). + * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ @@ -1309,12 +1431,12 @@ export interface paths { * * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; /** * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; }; @@ -1330,18 +1452,19 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; }; "/organizations/{organization_id}/custom_roles": { /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * @@ -1354,21 +1477,10 @@ export interface paths { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.13/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1382,26 +1494,16 @@ export interface paths { * * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.11/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.13/site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -1520,7 +1622,7 @@ export interface paths { * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -1529,7 +1631,7 @@ export interface paths { * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -1918,7 +2020,7 @@ export interface paths { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -1931,7 +2033,7 @@ export interface paths { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -1942,7 +2044,7 @@ export interface paths { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -2067,11 +2169,11 @@ export interface paths { "/orgs/{org}/audit-log": { /** * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -2082,7 +2184,7 @@ export interface paths { "/orgs/{org}/code-scanning/alerts": { /** * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an owner or security manager for the organization to use this endpoint. * @@ -2093,7 +2195,7 @@ export interface paths { "/orgs/{org}/custom-repository-roles": { /** * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2102,7 +2204,7 @@ export interface paths { get: operations["orgs/list-custom-repo-roles"]; /** * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2113,7 +2215,7 @@ export interface paths { "/orgs/{org}/custom-repository-roles/{role_id}": { /** * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2123,7 +2225,7 @@ export interface paths { /** * Delete a custom repository role * @description Deletes a custom role from an organization. Once the custom role has been deleted, any - * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2132,7 +2234,7 @@ export interface paths { delete: operations["orgs/delete-custom-repo-role"]; /** * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2279,7 +2381,7 @@ export interface paths { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2290,7 +2392,7 @@ export interface paths { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2299,7 +2401,7 @@ export interface paths { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2315,7 +2417,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; }; "/orgs/{org}/external-group/{group_id}": { @@ -2323,7 +2429,7 @@ export interface paths { * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; }; @@ -2332,14 +2438,16 @@ export interface paths { * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; }; "/orgs/{org}/hooks": { /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2370,7 +2478,9 @@ export interface paths { get: operations["orgs/get-webhook"]; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2452,7 +2562,7 @@ export interface paths { "/orgs/{org}/hooks/{hook_id}/pings": { /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) * to be sent to the hook. * * You must be an organization owner to use this endpoint. @@ -2467,7 +2577,7 @@ export interface paths { * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; }; @@ -2488,12 +2598,10 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -2531,13 +2639,13 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.13/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; /** @@ -2560,7 +2668,7 @@ 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.11/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)." + * 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.13/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"]; }; @@ -2593,7 +2701,7 @@ export interface paths { "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { /** * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; }; @@ -2614,7 +2722,7 @@ export interface paths { "/orgs/{org}/outside_collaborators/{username}": { /** * Convert an organization member to outside collaborator - * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.11/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.13/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; /** @@ -2628,7 +2736,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; }; @@ -2637,16 +2745,16 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; /** * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; }; @@ -2659,9 +2767,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; }; @@ -2670,7 +2778,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; }; @@ -2679,16 +2787,16 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; /** * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; }; @@ -2701,9 +2809,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; }; @@ -2808,6 +2916,71 @@ 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. + * Organization members can read these properties. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * Organization members can read these properties. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + */ + patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + }; "/orgs/{org}/public_members": { /** * List public organization members @@ -2825,7 +2998,7 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; /** @@ -2839,7 +3012,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; /** @@ -2853,7 +3027,7 @@ export interface paths { "/orgs/{org}/repository-fine-grained-permissions": { /** * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2873,10 +3047,29 @@ 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-server@3.13/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-server@3.13/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 * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -2904,7 +3097,7 @@ export interface paths { "/orgs/{org}/security-managers": { /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * @@ -2915,7 +3108,7 @@ export interface paths { "/orgs/{org}/security-managers/teams/{team_slug}": { /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2924,7 +3117,7 @@ export interface paths { put: operations["orgs/add-security-manager-team"]; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2953,9 +3146,9 @@ export interface paths { get: operations["teams/list"]; /** * Create a team - * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.11/articles/setting-team-creation-permissions-in-your-organization)." + * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.13/articles/setting-team-creation-permissions-in-your-organization)." * - * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; }; @@ -2964,7 +3157,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; /** @@ -2973,14 +3167,16 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; }; @@ -2989,7 +3185,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2998,9 +3195,10 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3011,7 +3209,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3020,7 +3219,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3029,7 +3229,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3040,7 +3241,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3049,9 +3251,10 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3062,7 +3265,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3071,7 +3275,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3080,7 +3285,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3089,20 +3295,22 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3111,9 +3319,10 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3122,20 +3331,22 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3144,9 +3355,10 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3157,21 +3369,21 @@ export interface paths { * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; }; @@ -3191,38 +3403,43 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; /** * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; }; @@ -3231,7 +3448,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; }; @@ -3240,21 +3458,24 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; }; @@ -3263,7 +3484,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; }; @@ -3272,29 +3494,32 @@ export interface paths { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * - * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; }; @@ -3303,18 +3528,19 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; }; "/orgs/{org}/{security_product}/{enablement}": { /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -3421,20 +3647,22 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.11/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.11/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.11/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.11/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.11/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions)." + * + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; }; @@ -3443,7 +3671,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; /** @@ -3458,7 +3687,7 @@ export interface paths { delete: operations["repos/delete"]; /** * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#replace-all-repository-topics) endpoint. + * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; }; @@ -3647,8 +3876,8 @@ export interface paths { * Get the level of access for workflows outside of the repository * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3657,8 +3886,8 @@ export interface paths { * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3689,7 +3918,7 @@ export interface paths { * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3698,7 +3927,7 @@ export interface paths { * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3849,13 +4078,13 @@ export interface paths { "/repos/{owner}/{repo}/actions/runs": { /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; }; @@ -3914,7 +4143,7 @@ export interface paths { /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -3946,20 +4175,30 @@ export interface paths { "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { /** * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ 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). + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope 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 * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -4061,7 +4300,7 @@ export interface paths { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -4182,11 +4421,13 @@ export interface paths { "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; }; @@ -4196,14 +4437,14 @@ 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 activity and data for your repository](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository)." + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.13/repositories/viewing-activity-and-data-for-your-repository)." */ get: operations["repos/list-activities"]; }; "/repos/{owner}/{repo}/assignees": { /** * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.11/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.13/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; }; @@ -4251,7 +4492,7 @@ export interface paths { "/repos/{owner}/{repo}/automated-security-fixes": { /** * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.11/articles/configuring-automated-security-fixes)". + * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.13/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; }; @@ -4266,42 +4507,44 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection": { /** * Get branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-branch-protection"]; /** * Update branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; /** * Delete branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { /** * Get admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; /** * Set admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -4310,44 +4553,46 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { /** * Get pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; /** * Delete pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; /** * Update pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { /** * Get commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.11/articles/signing-commits-with-gpg) in GitHub Help. + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.13/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; /** * Create commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -4356,17 +4601,17 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { /** * Get status checks protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; /** * Remove status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; /** * Update status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -4375,38 +4620,39 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { /** * Get all status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-all-status-check-contexts"]; /** * Set status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ put: operations["repos/set-status-check-contexts"]; /** * Add status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ post: operations["repos/add-status-check-contexts"]; /** * Remove status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { /** * Get access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; /** * Delete access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -4415,28 +4661,28 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { /** * Get apps with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -4445,28 +4691,28 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { /** * Get teams with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ @@ -4475,14 +4721,14 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { /** * Get users with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -4493,7 +4739,7 @@ export interface paths { put: operations["repos/set-user-access-restrictions"]; /** * Add user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -4504,7 +4750,7 @@ export interface paths { post: operations["repos/add-user-access-restrictions"]; /** * Remove user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -4519,7 +4765,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -4543,7 +4790,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4552,7 +4800,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4570,9 +4819,9 @@ export interface paths { "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4581,9 +4830,10 @@ export interface paths { "/repos/{owner}/{repo}/check-suites": { /** * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#update-repository-preferences-for-check-suites)". + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.13/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4592,7 +4842,7 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/preferences": { /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#create-a-check-suite). + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; @@ -4602,7 +4852,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4613,7 +4864,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4622,7 +4874,7 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { /** * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4679,8 +4931,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -4701,7 +4953,7 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * @@ -4796,7 +5048,7 @@ export interface paths { "/repos/{owner}/{repo}/code-scanning/sarifs": { /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -4809,7 +5061,7 @@ export interface paths { * ``` * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -4828,6 +5080,8 @@ export interface paths { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -4846,7 +5100,7 @@ export interface paths { * file. * * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * see "[About code owners](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; }; @@ -4878,17 +5132,17 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Updating an existing collaborator's permission level** * @@ -4913,11 +5167,12 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; }; @@ -4939,7 +5194,7 @@ export interface paths { * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4953,7 +5208,7 @@ export interface paths { * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4967,7 +5222,7 @@ export interface paths { * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4979,21 +5234,22 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). + * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; }; @@ -5010,6 +5266,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5034,7 +5291,7 @@ export interface paths { "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { /** * List branches for HEAD commit - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -5045,7 +5302,7 @@ export interface paths { * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5057,9 +5314,9 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5082,9 +5339,10 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -5100,6 +5358,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5126,9 +5385,10 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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.11/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.11/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * 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.13/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.13/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5139,7 +5399,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5171,11 +5432,11 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.13/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.diff`**: Returns the diff of the commit. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -5188,10 +5449,10 @@ export interface paths { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api)." * * **Signature verification object** * @@ -5203,6 +5464,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5229,7 +5491,7 @@ export interface paths { * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -5243,9 +5505,9 @@ export interface paths { * * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.13/rest/git/trees#get-a-tree). * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.13/rest/git/trees#get-a-tree). * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. * - If the requested file's size is: * - 1 MB or smaller: All features of this endpoint are supported. @@ -5258,7 +5520,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.13/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -5273,7 +5536,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.13/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -5301,7 +5565,7 @@ export interface paths { get: operations["dependabot/get-alert"]; /** * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -5339,7 +5603,7 @@ export interface paths { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5399,7 +5663,7 @@ export interface paths { * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) for every submitted context must be in a `success` + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.13/rest/commits/statuses) for every submitted context must be in a `success` * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do * not require any contexts or create any commit statuses, the deployment will always succeed. @@ -5448,7 +5712,7 @@ export interface paths { * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * * Mark the active deployment as inactive by adding any non-successful deployment status. * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#create-a-deployment-status)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ @@ -5478,7 +5742,7 @@ export interface paths { "/repos/{owner}/{repo}/dispatches": { /** * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#repository_dispatch)." + * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#repository_dispatch)." * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * @@ -5502,7 +5766,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -5513,9 +5778,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5538,7 +5805,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5547,7 +5814,7 @@ 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. * @@ -5556,14 +5823,14 @@ export interface paths { 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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope 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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5572,9 +5839,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -5585,7 +5852,7 @@ export interface paths { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5594,11 +5861,13 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app)". * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -5607,9 +5876,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -5661,7 +5930,7 @@ export interface paths { /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -5730,7 +5999,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; }; @@ -5741,9 +6011,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; }; @@ -5756,7 +6028,7 @@ export interface paths { * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw blob data. * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -5780,6 +6052,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5818,6 +6091,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5846,7 +6120,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -5857,7 +6132,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; }; @@ -5883,7 +6159,7 @@ export interface paths { "/repos/{owner}/{repo}/git/tags": { /** * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.13/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.13/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * * **Signature verification object** * @@ -5895,6 +6171,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5929,6 +6206,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5955,7 +6233,7 @@ export interface paths { * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.11/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.11/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.13/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.13/rest/git/refs#update-a-reference)." * * Returns an error if you try to delete a file that does not exist. */ @@ -5968,8 +6246,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; }; @@ -5992,7 +6270,12 @@ export interface paths { * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -6040,7 +6323,7 @@ export interface paths { "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { /** * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; }; @@ -6049,7 +6332,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; }; @@ -6058,7 +6342,7 @@ export interface paths { * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; }; @@ -6080,12 +6364,10 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6095,12 +6377,12 @@ export interface paths { get: operations["issues/list-for-repo"]; /** * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.11/articles/disabling-issues/), the API returns a `410 Gone` status. + * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.13/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6116,7 +6398,7 @@ export interface paths { * * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6130,7 +6412,7 @@ export interface paths { * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6147,7 +6429,7 @@ export interface paths { * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6159,21 +6441,22 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). + * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; }; @@ -6194,19 +6477,17 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}": { /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.11/articles/transferring-an-issue-to-another-repository/) to another repository. If + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + * [transferred](https://docs.github.com/enterprise-server@3.13/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - * to the [`issues`](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#issues) webhook. + * to the [`issues`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6216,9 +6497,9 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6257,7 +6538,7 @@ export interface paths { * * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6269,12 +6550,12 @@ export interface paths { * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6324,7 +6605,7 @@ export interface paths { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; /** @@ -6336,21 +6617,22 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). + * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; }; @@ -6436,7 +6718,7 @@ export interface paths { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -6495,7 +6777,7 @@ export interface paths { get: operations["activity/list-repo-notifications-for-authenticated-user"]; /** * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; }; @@ -6578,6 +6860,24 @@ export interface paths { */ post: operations["repos/create-pages-deployment"]; }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + get: operations["repos/get-pages-deployment"]; + }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + post: operations["repos/cancel-pages-deployment"]; + }; "/repos/{owner}/{repo}/pre-receive-hooks": { /** * List pre-receive hooks for a repository @@ -6613,6 +6913,22 @@ 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 read access to the repository can use this endpoint. + */ + get: operations["repos/get-custom-properties-values"]; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + patch: operations["repos/create-or-update-custom-properties-values"]; + }; "/repos/{owner}/{repo}/pulls": { /** * List pull requests @@ -6621,10 +6937,10 @@ export interface paths { * 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-server@3.11/github/getting-started-with-github/githubs-products) + * Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6634,13 +6950,13 @@ export interface paths { get: operations["pulls/list"]; /** * Create a pull request - * @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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6655,7 +6971,7 @@ export interface paths { * @description Lists review comments for all pull requests in a repository. By default, * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6669,7 +6985,7 @@ export interface paths { * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6686,7 +7002,7 @@ export interface paths { * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6698,44 +7014,45 @@ 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.11/rest/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.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { /** * Get a pull request - * @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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6746,11 +7063,11 @@ export interface paths { get: operations["pulls/get"]; /** * Update a pull request - * @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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6765,7 +7082,7 @@ export interface paths { * @description Lists all review comments for a specified pull request. By default, review comments * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6775,16 +7092,16 @@ export interface paths { get: operations["pulls/list-review-comments"]; /** * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#create-an-issue-comment)." + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#create-an-issue-comment)." * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6798,10 +7115,10 @@ export interface paths { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6814,10 +7131,10 @@ export interface paths { /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits) + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits) * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6831,10 +7148,10 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6852,14 +7169,14 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { /** * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** @@ -6878,7 +7195,7 @@ export interface paths { * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6890,15 +7207,16 @@ export interface paths { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6912,7 +7230,7 @@ export interface paths { * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6924,7 +7242,7 @@ export interface paths { * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6936,7 +7254,7 @@ export interface paths { * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6950,7 +7268,7 @@ export interface paths { * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6964,11 +7282,10 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6980,9 +7297,9 @@ export interface paths { "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6995,6 +7312,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -7003,7 +7321,7 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -7015,7 +7333,7 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -7025,7 +7343,7 @@ export interface paths { "/repos/{owner}/{repo}/releases": { /** * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-tags). + * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ @@ -7034,14 +7352,20 @@ export interface paths { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; /** Delete a release asset */ @@ -7055,7 +7379,7 @@ export interface paths { "/repos/{owner}/{repo}/releases/generate-notes": { /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; }; @@ -7080,9 +7404,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; /** @@ -7101,8 +7424,8 @@ export interface paths { get: operations["repos/list-release-assets"]; /** * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#create-a-release) to upload a release asset. + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * @@ -7116,9 +7439,9 @@ export interface paths { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.11/rest/releases/assets#list-release-assets)" + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.13/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-the-latest-release). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; @@ -7126,21 +7449,22 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions": { /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). + * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; }; @@ -7173,10 +7497,29 @@ 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-server@3.13/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-server@3.13/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 * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -7237,7 +7580,7 @@ export interface paths { * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -7318,12 +7661,12 @@ export interface paths { get: operations["activity/get-repo-subscription"]; /** * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#delete-a-repository-subscription) completely. + * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; /** * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#set-a-repository-subscription). + * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; }; @@ -7333,23 +7676,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -7360,7 +7715,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -7384,26 +7741,26 @@ export interface paths { "/repos/{owner}/{repo}/transfer": { /** * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.11/articles/about-repository-transfers/). + * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.13/articles/about-repository-transfers/). */ post: operations["repos/transfer"]; }; "/repos/{owner}/{repo}/vulnerability-alerts": { /** * Check if vulnerability alerts are enabled for a repository - * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". */ get: operations["repos/check-vulnerability-alerts"]; /** * Enable vulnerability alerts - * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". */ put: operations["repos/enable-vulnerability-alerts"]; /** * Disable vulnerability alerts * @description Disables dependency alerts for a repository. * The authenticated user must have admin access to the repository. For more information, - * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". */ delete: operations["repos/disable-vulnerability-alerts"]; }; @@ -7414,14 +7771,15 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; }; "/repos/{template_owner}/{template_repo}/generate": { /** * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ @@ -7434,14 +7792,15 @@ export interface paths { * * Note: * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; }; "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -7450,7 +7809,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -7461,14 +7821,16 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -7477,14 +7839,16 @@ export interface paths { put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -7497,7 +7861,8 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -7506,7 +7871,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -7519,59 +7885,66 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; }; "/search/code": { /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -7593,10 +7966,10 @@ export interface paths { "/search/commits": { /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -7607,10 +7980,10 @@ export interface paths { "/search/issues": { /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -7618,16 +7991,17 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.11/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.13/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; }; "/search/labels": { /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -7640,9 +8014,9 @@ export interface paths { "/search/repositories": { /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -7655,9 +8029,9 @@ export interface paths { "/search/topics": { /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.11/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.13/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -7670,9 +8044,9 @@ export interface paths { "/search/users": { /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -7680,7 +8054,7 @@ export interface paths { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.11/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.13/graphql/reference/queries#search)." */ get: operations["search/users"]; }; @@ -7717,26 +8091,28 @@ export interface paths { get: operations["enterprise-admin/get-maintenance-status"]; /** * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * @description > [!NOTE] + * > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; }; "/setup/api/settings": { /** * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#set-settings). + * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * > [!NOTE] + * > You cannot retrieve the management console password with the Enterprise administration API. */ get: operations["enterprise-admin/get-settings"]; /** * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings). + * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). * * **Notes:** * * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." */ put: operations["enterprise-admin/set-settings"]; }; @@ -7759,14 +8135,15 @@ export interface paths { * Create a GitHub license * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/create-enterprise-server-license"]; }; @@ -7775,7 +8152,8 @@ export interface paths { * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/upgrade-license"]; }; @@ -7783,13 +8161,15 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -7799,11 +8179,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -7811,7 +8193,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -7821,11 +8204,12 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7835,7 +8219,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -7845,7 +8230,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -7855,7 +8241,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -7867,7 +8254,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -7877,11 +8265,12 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7891,7 +8280,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -7901,7 +8291,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -7911,7 +8302,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -7923,9 +8315,10 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -7933,9 +8326,10 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * @@ -7947,9 +8341,10 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -7957,9 +8352,10 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * @@ -7971,7 +8367,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.11/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.13/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -7981,9 +8378,9 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. */ @@ -7991,31 +8388,33 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; }; @@ -8023,7 +8422,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -8032,19 +8432,21 @@ export interface paths { * **Note:** * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -8054,13 +8456,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; }; @@ -8068,7 +8472,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -8078,7 +8483,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -8086,7 +8492,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -8094,7 +8501,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -8104,7 +8512,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; }; @@ -8112,27 +8521,31 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -8142,7 +8555,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; }; @@ -8206,7 +8620,7 @@ export interface paths { get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ @@ -8275,11 +8689,15 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -8288,12 +8706,10 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -8405,6 +8821,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -8413,7 +8832,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; }; @@ -8422,14 +8841,14 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; /** * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; }; @@ -8442,7 +8861,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; }; @@ -8451,7 +8870,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; }; @@ -8460,7 +8879,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; /** @@ -8469,7 +8888,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; }; @@ -8482,7 +8901,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; }; @@ -8497,7 +8916,7 @@ export interface paths { /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) * endpoint. * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -8591,7 +9010,7 @@ export interface paths { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -8605,7 +9024,7 @@ export interface paths { get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; /** @@ -8633,12 +9052,23 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.13/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; }; @@ -8647,9 +9077,9 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.11/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.13/rest/users/emails)". */ get: operations["users/get-by-username"]; }; @@ -8665,7 +9095,10 @@ export interface paths { "/users/{username}/events": { /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; }; @@ -8673,11 +9106,18 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; }; "/users/{username}/followers": { @@ -8728,7 +9168,7 @@ export interface paths { * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; }; @@ -8742,9 +9182,9 @@ export interface paths { "/users/{username}/orgs": { /** * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.11/articles/publicizing-or-concealing-organization-membership) for the specified user. + * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.13/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; }; @@ -8753,7 +9193,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; }; @@ -8762,16 +9202,16 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; /** * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; }; @@ -8784,9 +9224,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; }; @@ -8795,7 +9235,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; }; @@ -8804,16 +9244,16 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; /** * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; }; @@ -8826,9 +9266,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; }; @@ -8842,12 +9282,20 @@ export interface paths { "/users/{username}/received_events": { /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -8860,7 +9308,7 @@ export interface paths { "/users/{username}/site_admin": { /** * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/promote-user-to-be-site-administrator"]; /** @@ -8888,7 +9336,7 @@ export interface paths { * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -8904,16 +9352,16 @@ export interface paths { "/users/{username}/suspended": { /** * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * * You can suspend any user account except your own. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/suspend-user"]; /** * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ delete: operations["enterprise-admin/unsuspend-user"]; }; @@ -8970,6 +9418,22 @@ export interface paths { */ get: operations["repos/compare-commits"]; }; + "/orgs/{org}/organization-fine-grained-permissions": { + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + }; } export type webhooks = Record; @@ -9081,9 +9545,11 @@ export interface components { ping_url?: string; }; "public-key-full": { + /** Format: int64 */ id: number; key: string; user_id: number | null; + /** Format: int64 */ repository_id: number | null; url: string; title: string; @@ -9119,7 +9585,10 @@ export interface components { ldap_dn?: string; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9233,6 +9702,8 @@ export interface components { /** Format: date-time */ suspended_at?: string | null; business_plus?: boolean; + /** @example public */ + user_view_type?: string; }; /** * Organization Simple @@ -9274,6 +9745,7 @@ export interface components { description: string | null; }; "pre-receive-environment": { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9307,6 +9779,7 @@ export interface components { html_url?: string; }; environment?: { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9333,7 +9806,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9392,6 +9868,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * App Permissions @@ -9469,6 +9947,11 @@ export interface components { * @enum {string} */ pull_requests?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + * @enum {string} + */ + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} @@ -9530,7 +10013,17 @@ export interface components { */ organization_custom_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for custom organization roles management. + * @enum {string} + */ + organization_custom_org_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom property management. + * @enum {string} + */ + organization_custom_properties?: "read" | "write" | "admin"; + /** + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -9565,7 +10058,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -9639,7 +10132,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9698,6 +10194,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** Scoped Installation */ "nullable-scoped-installation": { @@ -9730,6 +10228,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -9790,6 +10289,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ vulnerable_functions: readonly string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; /** * @description The type of credit the user is receiving. * @enum {string} @@ -9888,6 +10401,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -9896,6 +10410,10 @@ export interface components { name: string; }[] | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; /** @description In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available. */ credits: | readonly { @@ -9996,8 +10514,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -10017,7 +10533,7 @@ export interface components { */ "webhook-config-content-type": string; /** - * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers). + * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers). * @example "********" */ "webhook-config-secret": string; @@ -10093,6 +10609,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -10183,6 +10705,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -10370,6 +10898,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -10661,7 +11190,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10748,7 +11277,10 @@ export interface components { * @description The authorization associated with an OAuth Access. */ "application-grant": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * Format: uri @@ -10845,7 +11377,7 @@ export interface components { html_url: string | null; }; /** - * @description The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.11/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + * @description The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.13/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." * @example Very **important** announcement about _something_. */ "announcement-message": string | null; @@ -11246,9 +11778,9 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -11264,10 +11796,10 @@ export interface components { * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -11275,8 +11807,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -11289,6 +11819,8 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -11350,6 +11882,7 @@ export interface components { */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -11611,6 +12144,11 @@ export interface components { * @example false */ advanced_security_enabled_for_new_repositories: boolean; + /** + * @description Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. + * @example false + */ + advanced_security_enabled_for_new_user_namespace_repositories?: boolean; /** * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this * enterprise. @@ -11682,6 +12220,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -11815,7 +12354,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -11831,11 +12370,18 @@ export interface components { push_protection_bypassed_at?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; "advanced-security-active-committers-user": { user_login: string; /** @example 2021-11-03 */ last_pushed_date: string; + /** @example monalisa@github.com */ + last_pushed_email: string; }; "advanced-security-active-committers-repository": { /** @example octocat/Hello-World */ @@ -11849,6 +12395,16 @@ export interface components { total_advanced_security_committers?: number; /** @example 2 */ total_count?: number; + /** + * @description The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security + * @example 4 + */ + maximum_advanced_security_committers?: number; + /** + * @description The total number of GitHub Advanced Security licences purchased + * @example 4 + */ + purchased_advanced_security_committers?: number; repositories: components["schemas"]["advanced-security-active-committers-repository"][]; }; /** @@ -12007,8 +12563,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -12045,6 +12599,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -12152,6 +12712,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -12311,6 +12872,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -12334,7 +12900,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -12365,6 +12933,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -12382,8 +12952,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -12492,6 +13060,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -12687,6 +13260,158 @@ export interface components { /** @example true */ featured: boolean; }; + "ghes-get-ssh": { + /** + * Format: ssh-key + * @description The full public key + */ + key?: string; + /** + * Format: ssh-key fingerprint + * @description The fingerprint of the key + */ + fingerprint?: string; + }[]; + /** Set SSH key */ + "ghes-set-ssh-request": { + /** @description The public SSH key to add to the `authorized_keys` file. */ + key: string; + }; + "ghes-set-ssh-response": { + /** + * Format: hostname + * @description Hostname of the node where the SSH key was added. + */ + hostname?: string; + /** + * Format: uuid + * @description UUID of the SSH key that was added. + */ + uuid?: string; + /** @description Message indicating the result of the SSH key addition. */ + message?: string; + /** @description Error message indicating the reason for the SSH key addition failure. This field is only present if the SSH key addition failed. */ + error?: string; + /** @description Whether the SSH key was already present on the `authorized_keys` file. */ + modified?: boolean; + }[]; + /** Set SSH key */ + "ghes-delete-ssh-request": { + /** @description The public SSH key to remove from the `authorized_keys` file. */ + key: string; + }; + "ghes-delete-ssh-response": { + /** + * Format: hostname + * @description Hostname of the node where the SSH key was removed. + */ + hostname?: string; + /** + * Format: uuid + * @description UUID of the SSH key that was removed. + */ + uuid?: string; + /** @description Message indicating the result of the SSH key removal. */ + message?: string; + /** @description Error message indicating the reason for the SSH key removal failure. This field is only present if the SSH key removal failed. */ + error?: string; + }[]; + /** @enum {string} */ + "ghes-checks-result-indicator": "OK" | "FAILED"; + "ghes-checks-system-requirements": { + status?: components["schemas"]["ghes-checks-result-indicator"]; + nodes?: { + hostname?: string; + status?: components["schemas"]["ghes-checks-result-indicator"]; + roles_status?: { + status?: components["schemas"]["ghes-checks-result-indicator"]; + role?: string; + }[]; + }[]; + }; + /** @enum {string} */ + "ghes-cluster-status-indicator": "UNKNOWN" | "OK" | "WARNING" | "CRITICAL"; + "ghes-cluster-status": { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + nodes?: { + hostname?: string; + status?: components["schemas"]["ghes-cluster-status-indicator"]; + services?: { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + name?: string; + details?: string; + }[]; + }[]; + }; + /** Initialize configuration with license upload */ + "ghes-config-init-request": { + /** @description The content of your _.ghl_ license file. */ + license: string; + /** @description The root site administrator password. */ + password: string; + }; + "ghes-license-info": { + /** @description Whether the GitHub Advanced Security feature is enabled. */ + advancedSecurityEnabled?: boolean; + /** @description If the GitHub Advanced Security feature is enabled, the seat count. */ + advancedSecuritySeats?: number; + /** @description Whether the cluster support feature is enabled. */ + clusterSupport?: boolean; + /** @description The company under which the license is issued. */ + company?: string; + /** @description Whether the Github Connect feature is enabled. */ + croquetSupport?: boolean; + /** @description Whether this license is issued under custom terms. */ + customTerms?: boolean; + /** @description Wheter this license is issued as an evaluation license. */ + evaluation?: boolean; + /** + * Format: date-time + * @description The expiration date of the license. + * @example 2025-01-02T07:59:59Z + */ + expireAt?: string; + /** @description Whether the insights feature is enabled. */ + insightsEnabled?: boolean; + /** + * Format: date-time + * @description If the insights feature is enabled, the expiration date. + * @example 2025-01-02T07:59:59Z + */ + insightsExpireAt?: string; + /** + * Format: date-time + * @description If the learning lab feature is enabled, the expiration date. + * @example 2025-01-02T07:59:59Z + */ + learningLabEvaluationExpires?: string; + /** @description If the learning lab feature is enabled, the seat count. */ + learningLabSeats?: number; + /** @description Whether the perpetual feature is enabled. */ + perpetual?: boolean; + /** @description The unique reference number of the license. */ + referenceNumber?: string; + /** @description If the license is issued with limited seating, the seat count. */ + seats?: number; + /** @description Whether the SSH feature is enabled. */ + sshAllowed?: boolean; + /** @description The support key of the license. */ + supportKey?: string; + /** @description Whether the license is issued with unlimited seat count. */ + unlimitedSeating?: boolean; + }; + /** License upload form */ + "ghes-upload-license-request": { + /** @description The content of your _.ghl_ license file. */ + license: string; + }; + "ghes-license-check": { + /** + * @description The license status of the currently active enterprise license. + * @enum {string} + */ + status?: "valid" | "invalid" | "expired" | "cluster mode not supported"; + }; /** @enum {string} */ "ghes-cluster-topology": "SingleNode" | "Ha" | "Cluster"; /** @enum {string} */ @@ -12715,6 +13440,141 @@ export interface components { cluster_roles?: components["schemas"]["ghes-cluster-roles"][]; }[]; }; + "ghes-get-settings": { + private_mode?: boolean; + public_pages?: boolean; + subdomain_isolation?: boolean; + signup_enabled?: boolean; + github_hostname?: string; + identicons_host?: string; + http_proxy?: string | null; + auth_mode?: string; + expire_sessions?: boolean; + admin_password?: string | null; + configuration_id?: number; + configuration_run_count?: number; + avatar?: { + enabled?: boolean; + uri?: string; + }; + customer?: { + name?: string; + email?: string; + uuid?: string; + secret_key_data?: string; + public_key_data?: string; + }; + license?: { + seats?: number; + evaluation?: boolean; + perpetual?: boolean; + unlimited_seating?: boolean; + support_key?: string; + ssh_allowed?: boolean; + cluster_support?: boolean; + expire_at?: string; + }; + github_ssl?: { + enabled?: boolean; + cert?: string | null; + key?: string | null; + }; + ldap?: { + host?: string | null; + port?: number; + base?: string[]; + uid?: string | null; + bind_dn?: string | null; + password?: string | null; + method?: string; + search_strategy?: string; + user_groups?: string[]; + admin_group?: string | null; + virtual_attribute_enabled?: boolean; + recursive_group_search?: boolean; + posix_support?: boolean; + user_sync_emails?: boolean; + user_sync_keys?: boolean; + user_sync_interval?: number; + team_sync_interval?: number; + sync_enabled?: boolean; + reconciliation?: { + user?: string | null; + org?: string | null; + }; + profile?: { + uid?: string; + name?: string | null; + mail?: string | null; + key?: string | null; + }; + }; + cas?: { + url?: string | null; + }; + saml?: { + sso_url?: string | null; + certificate?: string | null; + certificate_path?: string | null; + issuer?: string | null; + idp_initiated_sso?: boolean; + disable_admin_demote?: boolean; + }; + github_oauth?: { + client_id?: string; + client_secret?: string; + organization_name?: string; + organization_team?: string; + }; + smtp?: { + enabled?: boolean; + address?: string; + authentication?: string; + port?: string; + domain?: string; + username?: string; + user_name?: string; + enable_starttls_auto?: boolean; + password?: string; + "discard-to-noreply-address"?: boolean; + support_address?: string; + support_address_type?: string; + noreply_address?: string; + }; + ntp?: { + primary_server?: string; + secondary_server?: string; + }; + timezone?: string | null; + snmp?: { + enabled?: boolean; + community?: string; + }; + syslog?: { + enabled?: boolean; + server?: string | null; + protocol_name?: string; + }; + assets?: string | null; + pages?: { + enabled?: boolean; + }; + collectd?: { + enabled?: boolean; + server?: string | null; + port?: number; + encryption?: string | null; + username?: string | null; + password?: string | null; + }; + mapping?: { + enabled?: boolean; + tileserver?: string | null; + basemap?: string; + token?: string | null; + }; + load_balancer?: string | null; + }; "ghes-get-maintenance": { /** Format: hostname */ hostname?: string; @@ -12806,20 +13666,27 @@ export interface components { * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ - dependabot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; - /** @example 3.11.0 */ + /** @example 3.13.0 */ installed_version?: string; }; "security-and-analysis": { @@ -12849,7 +13716,10 @@ export interface components { * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -13215,7 +14085,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -13260,40 +14135,35 @@ export interface components { */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @description Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -13575,7 +14445,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14044,7 +14917,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -14175,6 +15051,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14187,7 +15067,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -14211,6 +15091,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14290,12 +15174,102 @@ 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 + */ + "custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + 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 | 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"][]; + }; /** * Repository * @description A repository on GitHub. */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -14587,7 +15561,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -14671,7 +15645,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14971,6 +15948,10 @@ export interface components { anonymous_access_enabled?: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Repository Fine-Grained Permission @@ -14981,7 +15962,7 @@ export interface components { description: 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. + * @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 not available for the `repository` target. * @enum {string} */ "repository-rule-enforcement": "disabled" | "active" | "evaluate"; @@ -15002,8 +15983,8 @@ export interface components { | "RepositoryRole" | "Team"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -15044,15 +16025,46 @@ export interface components { repository_ids?: number[]; }; }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ + name: string; + /** @description The values to match for the repository property */ + property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; + }; + /** + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition + */ + "repository-ruleset-conditions-repository-property-target": { + repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; + }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & - components["schemas"]["repository-ruleset-conditions-repository-id-target"]); + components["schemas"]["repository-ruleset-conditions-repository-id-target"]) + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** * creation * @description Only allow users with bypass permission to create matching refs. @@ -15109,6 +16121,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -15117,6 +16141,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -15147,6 +16173,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -15288,6 +16316,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -15325,7 +16355,7 @@ export interface components { * @description The target of the ruleset. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; /** * @description The type of the source of the ruleset * @enum {string} @@ -15351,7 +16381,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: | ( @@ -15366,73 +16396,172 @@ export interface components { updated_at?: string; }; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * Rule Suites + * @description Response */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; + "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; /** - * @description Permission that the team will have for its repositories - * @example admin + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - permission: string; + pushed_at?: string; /** - * @description The level of privacy this team should have - * @example closed + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - privacy?: string; + result?: "pass" | "fail" | "bypass"; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @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} */ - notification_setting?: 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 | null; + /** @description The handle for the GitHub user account. */ + actor_name?: string | null; + /** @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: uri - * @example https://github.com/orgs/rails/teams/core + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - html_url: string; + pushed_at?: string; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - repositories_url: string; - /** @example justice-league */ - slug: string; + result?: "pass" | "fail" | "bypass"; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @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`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - ldap_dn?: string; + evaluation_result?: "pass" | "fail" | null; + /** @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 The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; + }[]; }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - "nullable-team-simple": { + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { /** * @description Unique identifier of the team * @example 1 @@ -16257,6 +17386,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -16372,6 +17502,7 @@ export interface components { code_scanning_upload?: components["schemas"]["rate-limit"]; actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -16699,6 +17830,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -16706,6 +17838,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -16715,6 +17848,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -16986,6 +18120,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -17037,6 +18172,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -17322,6 +18458,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -17339,6 +18476,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -17394,8 +18532,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -17589,8 +18730,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -17808,6 +18955,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -17965,7 +19113,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -18070,7 +19221,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -18170,6 +19321,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -18204,7 +19356,7 @@ export interface components { * @description The desired state of code scanning default setup. * @enum {string} */ - state: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description CodeQL query suite to be used. * @enum {string} @@ -18212,6 +19364,7 @@ export interface components { query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -18221,7 +19374,6 @@ export interface components { | "ruby" | "swift" )[]; - [key: string]: unknown; }; /** * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. @@ -18239,7 +19391,7 @@ export interface components { * @example refs/heads/main */ "code-scanning-ref-full": string; - /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.11/code-security/secure-coding/sarif-support-for-code-scanning)." */ + /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.13/code-security/secure-coding/sarif-support-for-code-scanning)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { id?: components["schemas"]["code-scanning-analysis-sarif-id"]; @@ -18316,7 +19468,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -18384,6 +19539,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; }; /** * Collaborator @@ -18392,7 +19549,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -18460,6 +19620,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -18540,7 +19702,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -18775,6 +19940,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -18788,7 +19954,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -18992,6 +20157,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -19026,6 +20207,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -19138,6 +20320,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -19157,11 +20344,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -19172,7 +20357,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -19209,6 +20394,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -19227,6 +20417,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -19354,7 +20555,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -19386,7 +20590,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -19445,6 +20649,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -19521,21 +20726,27 @@ export interface components { "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": { @@ -19547,6 +20758,12 @@ export interface components { * @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": { @@ -19911,6 +21128,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -20047,6 +21265,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -20464,6 +21683,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -20480,14 +21700,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -20698,11 +21924,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -20723,12 +21951,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -21205,10 +22433,12 @@ export interface components { * @description The GitHub Pages deployment status. */ "page-deployment": { + /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ + id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. - * @example https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251 + * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ status_url: string; /** @@ -21224,6 +22454,25 @@ export interface components { */ preview_url?: string; }; + /** GitHub Pages deployment status */ + "pages-deployment-status": { + /** + * @description The current status of the deployment. + * @enum {string} + */ + status?: + | "deployment_in_progress" + | "syncing_files" + | "finished_file_sync" + | "updating_pages" + | "purging_cdn" + | "deployment_cancelled" + | "deployment_failed" + | "deployment_content_failed" + | "deployment_attempt_error" + | "deployment_lost" + | "succeed"; + }; "repository-pre-receive-hook": { id?: number; name?: string; @@ -21240,7 +22489,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -21349,359 +22601,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -21769,6 +22678,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -21822,9 +22732,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -22077,7 +22993,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -22090,6 +23006,11 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -22182,7 +23103,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -22191,7 +23112,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -22879,6 +23800,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -23105,6 +24032,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -23150,6 +24078,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; "configuration-status": { status?: string; @@ -23315,8 +24244,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -23385,6 +24318,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -23426,8 +24364,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -23453,7 +24389,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -23493,6 +24432,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -23534,6 +24474,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -23594,7 +24535,7 @@ export interface components { * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts)." + * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.13/admin/overview/about-enterprise-accounts)." */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -23643,7 +24584,7 @@ export interface components { * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.13/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -23704,6 +24645,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -23904,6 +24846,10 @@ export interface components { */ is_template?: boolean; topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -24139,7 +25085,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -24200,78 +25146,9 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. */ webhooks_rule: { admin_enforced: boolean; @@ -24451,9 +25328,9 @@ export interface components { webhooks_code_scanning_ref: string; /** @description The pusher type for the event. Can be either `user` or a deploy key. */ webhooks_deploy_pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/enterprise-server@3.11/rest/git/refs#get-a-reference) resource. */ + /** @description The [`git ref`](https://docs.github.com/enterprise-server@3.13/rest/git/refs#get-a-reference) resource. */ webhooks_ref_0: string; - /** @description The [`deploy key`](https://docs.github.com/enterprise-server@3.11/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ + /** @description The [`deploy key`](https://docs.github.com/enterprise-server@3.13/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ webhooks_deploy_key: { added_by?: string | null; created_at: string; @@ -24503,6 +25380,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -24572,6 +25450,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24591,6 +25470,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -24650,6 +25530,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24669,6 +25550,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -24714,6 +25596,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -24801,6 +25684,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24820,7 +25704,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -24878,6 +25764,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24897,6 +25784,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -24944,7 +25832,7 @@ export interface components { webhooks_repository_selection: "all" | "selected"; /** * issue comment - * @description The [comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment) itself. */ webhooks_issue_comment: { /** @@ -25014,6 +25902,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25033,6 +25922,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -25044,7 +25934,7 @@ export interface components { }; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ webhooks_issue: { /** @enum {string|null} */ @@ -25090,6 +25980,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -25126,6 +26017,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -25221,6 +26113,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -25351,6 +26244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -25458,6 +26352,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -25492,6 +26392,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25511,6 +26412,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -25559,6 +26461,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -25586,7 +26489,7 @@ export interface components { }; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ webhooks_issue_2: { /** @enum {string|null} */ @@ -25632,6 +26535,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -25668,6 +26572,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -25763,6 +26668,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -25891,6 +26797,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -25998,6 +26905,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -26032,6 +26945,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26051,6 +26965,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -26089,6 +27004,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Team @@ -26161,6 +27077,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -26361,6 +27278,10 @@ export interface components { */ is_template?: boolean; topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -26596,7 +27517,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -26703,6 +27624,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26756,6 +27678,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26775,6 +27698,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26843,6 +27767,10 @@ export interface components { | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -26898,6 +27826,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -26954,6 +27883,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -27116,7 +28046,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -27209,6 +28139,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -27305,6 +28236,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -27432,7 +28364,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -27525,6 +28460,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -27614,6 +28550,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27633,6 +28570,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -27772,7 +28710,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -27865,6 +28806,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -27954,6 +28896,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27973,6 +28916,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -28040,6 +28984,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -28087,6 +29032,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -28295,6 +29241,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28314,11 +29261,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ webhooks_review_comment: { _links: { @@ -28448,6 +29396,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28467,6 +29416,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -28528,6 +29478,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28547,12 +29498,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases/#get-a-release) object. */ webhooks_release: { assets: { @@ -28653,6 +29605,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -28699,7 +29652,7 @@ export interface components { }; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases/#get-a-release) object. */ webhooks_release_1: { assets: ({ @@ -28800,6 +29753,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -28960,6 +29914,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -29012,6 +29967,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -29051,6 +30007,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -29088,6 +30045,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -29201,7 +30159,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -29211,7 +30169,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -29222,7 +30180,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -29233,7 +30191,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -29257,6 +30215,13 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -29270,7 +30235,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-cache-sync": { after: string; @@ -29281,7 +30246,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -29291,7 +30256,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -29309,7 +30274,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -29332,7 +30297,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -29350,7 +30315,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -29364,7 +30329,7 @@ export interface components { "webhook-check-suite-completed": { /** @enum {string} */ action: "completed"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -29436,6 +30401,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -29475,6 +30442,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -29668,13 +30636,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { /** @enum {string} */ action: "requested"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -29747,6 +30715,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -29786,6 +30756,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -29972,13 +30943,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { /** @enum {string} */ action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -30046,6 +31017,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -30085,6 +31058,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -30270,7 +31244,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -30324,6 +31298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -30400,7 +31375,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -30454,6 +31429,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -30537,7 +31513,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -30612,9 +31588,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -30632,7 +31608,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -30686,6 +31662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -30771,7 +31748,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -30864,7 +31841,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -30948,7 +31925,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -30957,7 +31934,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -31024,6 +32001,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -31043,13 +32021,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; 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"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -31068,7 +32047,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** delete event */ "webhook-delete": { @@ -31083,7 +32062,29 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert auto-dismissed event */ + "webhook-dependabot-alert-auto-dismissed": { + /** @enum {string} */ + action: "auto_dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert auto-reopened event */ + "webhook-dependabot-alert-auto-reopened": { + /** @enum {string} */ + action: "auto_reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -31094,7 +32095,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -31105,7 +32106,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -31116,7 +32117,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -31127,7 +32128,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -31138,7 +32139,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -31149,7 +32150,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -31160,7 +32161,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -31168,7 +32169,7 @@ export interface components { action: "created"; /** * Deployment - * @description The [deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -31208,6 +32209,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -31321,6 +32323,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31417,7 +32420,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -31457,6 +32460,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -31707,6 +32711,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -31734,7 +32739,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -31746,7 +32751,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -31797,6 +32802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -31873,6 +32879,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31985,6 +32992,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32047,6 +33055,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32066,7 +33075,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -32117,6 +33126,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -32192,6 +33202,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32304,6 +33315,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32365,6 +33377,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32421,11 +33434,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -32475,6 +33489,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -32550,6 +33565,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32662,6 +33678,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -32724,6 +33741,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32779,7 +33797,7 @@ export interface components { } | null; /** * Deployment - * @description The [deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -32819,6 +33837,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -32932,6 +33951,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33024,7 +34044,7 @@ export interface components { /** Format: uri */ url: string; }; - /** @description The [deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#list-deployment-statuses). */ + /** @description The [deployment status](https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; /** User */ @@ -33063,6 +34083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -33181,6 +34202,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33274,7 +34296,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -33314,6 +34336,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33565,6 +34588,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33584,7 +34608,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -33612,7 +34636,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -33623,7 +34647,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -33635,7 +34659,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -33647,7 +34671,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -33664,7 +34688,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -33675,7 +34699,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -33686,7 +34710,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -33705,7 +34729,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -33717,7 +34741,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -33728,7 +34752,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -33739,7 +34763,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -33750,7 +34774,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -33765,7 +34789,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -33775,7 +34799,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -33787,7 +34811,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -33798,7 +34822,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -33809,17 +34833,17 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-disabled": { /** @enum {string} */ action: "anonymous_access_disabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-enabled": { /** @enum {string} */ action: "anonymous_access_enabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** * fork event @@ -33827,7 +34851,7 @@ export interface components { */ "webhook-fork": { enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The created [`repository`](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository) resource. */ + /** @description The created [`repository`](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#get-a-repository) resource. */ forkee: { /** * @description Whether to allow auto-merge for pull requests. @@ -33880,10 +34904,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -33940,7 +34960,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -34016,6 +35039,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -34167,13 +35191,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -34201,7 +35225,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -34213,7 +35237,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -34225,7 +35249,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -34237,7 +35261,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -34261,7 +35285,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -34285,7 +35309,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -34297,7 +35321,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -34337,6 +35361,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -34352,7 +35377,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -34365,7 +35390,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -34373,7 +35398,7 @@ export interface components { action: "created"; /** * issue comment - * @description The [comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -34443,6 +35468,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34462,11 +35488,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -34511,6 +35538,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -34547,6 +35575,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34642,6 +35671,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34772,6 +35802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34879,6 +35910,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -34913,6 +35950,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34932,6 +35970,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -34971,6 +36010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -35033,6 +36073,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -35048,7 +36089,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -35057,7 +36098,7 @@ export interface components { comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -35102,6 +36143,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35138,6 +36180,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35233,6 +36276,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35361,6 +36405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35468,6 +36513,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35502,6 +36553,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35521,6 +36573,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -35560,6 +36613,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -35622,6 +36676,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -35633,11 +36688,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -35647,7 +36703,7 @@ export interface components { comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -35692,6 +36748,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35728,6 +36785,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35823,6 +36881,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35953,6 +37012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36060,6 +37120,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36094,6 +37160,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36113,6 +37180,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36152,6 +37220,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -36214,6 +37283,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36229,7 +37299,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -36244,7 +37314,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -36255,7 +37325,7 @@ export interface components { action: "closed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -36300,6 +37370,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36336,6 +37407,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36431,6 +37503,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36562,6 +37635,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36669,6 +37743,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36703,6 +37783,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36722,6 +37803,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36770,6 +37852,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36781,11 +37864,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -36795,7 +37879,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36841,6 +37925,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36972,6 +38057,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37101,6 +38187,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37208,6 +38295,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37242,6 +38335,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37261,11 +38355,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -37275,7 +38370,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -37452,6 +38547,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37580,6 +38676,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37687,6 +38784,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37721,6 +38824,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37740,12 +38844,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -37766,7 +38871,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -37812,6 +38917,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37943,6 +39049,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38074,6 +39181,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38181,6 +39289,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38215,6 +39329,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38234,12 +39349,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -38249,7 +39365,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -38295,6 +39411,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38426,6 +39543,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38556,6 +39674,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38663,6 +39782,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38697,6 +39822,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38716,12 +39842,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -38731,7 +39858,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -38777,6 +39904,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38813,6 +39941,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -38909,6 +40038,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39039,6 +40169,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39146,6 +40277,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39180,6 +40317,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39199,11 +40337,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -39213,7 +40352,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -39390,6 +40529,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39519,6 +40659,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39626,6 +40767,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39660,6 +40807,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39679,12 +40827,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -39693,7 +40842,7 @@ export interface components { changes?: { /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ old_issue: { /** @enum {string|null} */ @@ -39739,6 +40888,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39775,6 +40925,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -39870,6 +41021,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39998,6 +41150,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40105,6 +41258,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40139,6 +41298,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40158,6 +41318,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -40216,6 +41377,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -40274,7 +41439,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -40350,6 +41518,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -40404,7 +41573,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -40450,6 +41619,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40486,6 +41656,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40581,6 +41752,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40712,6 +41884,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40819,6 +41992,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40853,6 +42032,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40872,11 +42052,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -40887,7 +42068,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -40897,7 +42078,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -41074,6 +42255,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41204,6 +42386,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41311,6 +42494,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41345,6 +42534,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41364,11 +42554,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -41377,7 +42568,7 @@ export interface components { changes: { /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ new_issue: { /** @enum {string|null} */ @@ -41423,6 +42614,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41459,6 +42651,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -41554,6 +42747,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41682,6 +42876,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41789,6 +42984,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41823,6 +43024,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41842,6 +43044,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -41900,6 +43103,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -41961,7 +43168,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -42037,6 +43247,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -42092,7 +43303,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -42107,7 +43318,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -42119,7 +43330,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -42129,7 +43340,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -42175,6 +43386,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42211,6 +43423,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -42307,6 +43520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42435,6 +43649,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42542,6 +43757,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42576,6 +43797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42595,11 +43817,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -42610,7 +43833,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -42621,7 +43844,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -42632,7 +43855,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -42658,34 +43881,24 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { /** @enum {string} */ action: "added"; changes?: { - /** - * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - * assigned to the collaborator, use the `role_name` field instead, which will provide the full - * role name, including custom roles. - */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; - /** @description The role assigned to the collaborator. */ - role_name?: { - to: string; - }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -42707,7 +43920,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -42718,7 +43931,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -42770,6 +43983,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -42823,6 +44037,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -42907,7 +44122,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -42918,7 +44133,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -42929,7 +44144,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -42940,7 +44155,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -42966,7 +44181,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -42977,7 +44192,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -42988,7 +44203,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -42999,7 +44214,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -43054,6 +44269,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -43063,7 +44279,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -43075,7 +44291,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -43091,7 +44307,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -43165,6 +44381,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -43204,6 +44421,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -43341,6 +44559,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -43376,7 +44595,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -43431,6 +44650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -43470,6 +44690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -43541,6 +44762,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -43577,11 +44799,11 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.11/rest/pages/pages#list-github-pages-builds) itself. */ + /** @description The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.13/rest/pages/pages#list-github-pages-builds) itself. */ build: { commit: string | null; created_at: string; @@ -43625,6 +44847,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -43636,15 +44859,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { /** @enum {string} */ action: "approved"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -43652,8 +44876,9 @@ export interface components { /** @enum {string} */ action: "cancelled"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -43661,9 +44886,10 @@ export interface components { /** @enum {string} */ action: "created"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ "webhook-personal-access-token-request-denied": { @@ -43671,7 +44897,8 @@ export interface components { action: "denied"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -43718,7 +44945,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -43741,7 +44968,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -43752,7 +44979,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -43809,6 +45036,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -43822,7 +45050,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -43838,7 +45066,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -43899,6 +45127,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -43944,7 +45173,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -43955,7 +45184,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -43966,7 +45195,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -43977,7 +45206,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -43993,7 +45222,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -44004,7 +45233,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -44015,7 +45244,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -44026,7 +45255,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -44048,7 +45277,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -44059,7 +45288,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -44068,7 +45297,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -44077,7 +45306,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -44086,7 +45315,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -44113,7 +45342,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -44123,7 +45352,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -44138,7 +45367,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -44147,7 +45376,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -44156,12 +45385,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { @@ -44181,7 +45414,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -44196,7 +45429,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -44206,7 +45439,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -44215,7 +45448,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -44223,7 +45456,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -44322,6 +45555,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44358,6 +45592,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -44418,6 +45653,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -44545,7 +45781,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -44638,6 +45877,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -44701,7 +45941,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -44730,6 +45970,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44749,6 +45990,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -44888,7 +46130,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -44981,6 +46226,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45044,7 +46290,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -45073,6 +46319,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45092,6 +46339,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -45159,6 +46407,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -45206,6 +46455,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45274,6 +46524,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -45414,6 +46665,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45433,10 +46685,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -45534,6 +46787,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45630,6 +46884,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -45757,7 +47012,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -45850,6 +47108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45913,7 +47172,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -45942,6 +47201,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45961,6 +47221,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -46100,7 +47361,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46193,6 +47457,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46256,7 +47521,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46285,6 +47550,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46304,6 +47570,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -46371,6 +47638,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -46418,6 +47686,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46486,6 +47755,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -46626,6 +47896,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46645,11 +47916,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -46747,6 +48019,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46843,6 +48116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -46970,7 +48244,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47063,6 +48340,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47126,7 +48404,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47155,6 +48433,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47174,6 +48453,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -47406,6 +48686,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47469,7 +48750,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47498,6 +48779,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47517,6 +48799,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -47584,6 +48867,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -47631,6 +48915,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47699,6 +48984,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -47839,6 +49125,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47858,11 +49145,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -47874,7 +49162,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -47886,7 +49174,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -47898,7 +49186,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -47929,7 +49217,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -48028,6 +49316,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48124,6 +49413,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48251,7 +49541,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48344,6 +49637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48407,7 +49701,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48436,6 +49730,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48455,6 +49750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -48594,7 +49890,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48687,6 +49986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48750,7 +50050,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48779,6 +50079,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48798,6 +50099,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -48865,6 +50167,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -48912,6 +50215,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48980,6 +50284,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -49120,6 +50425,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49139,10 +50445,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -49240,6 +50547,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49336,6 +50644,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -49463,7 +50772,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49556,6 +50868,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49619,7 +50932,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49648,6 +50961,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49667,6 +50981,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -49806,7 +51121,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49899,6 +51217,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49962,7 +51281,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49991,6 +51310,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50010,6 +51330,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50077,6 +51398,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -50124,6 +51446,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50192,6 +51515,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50332,6 +51656,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50351,10 +51676,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -50366,7 +51692,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -50378,7 +51704,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -50390,7 +51716,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -50402,7 +51728,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -50410,7 +51736,7 @@ export interface components { action: "created"; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -50540,6 +51866,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50559,6 +51886,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -50650,6 +51978,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50746,6 +52075,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -50873,7 +52203,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50966,6 +52299,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51029,7 +52363,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51058,6 +52392,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51077,6 +52412,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51209,7 +52545,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51302,6 +52641,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51365,7 +52705,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51394,6 +52734,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51413,6 +52754,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -51484,6 +52826,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51550,6 +52893,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -51684,6 +53028,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51703,10 +53048,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -51802,6 +53148,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -51898,6 +53245,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52025,7 +53373,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52118,6 +53469,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52181,7 +53533,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52210,6 +53562,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52229,6 +53582,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52361,7 +53715,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52454,6 +53811,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52517,7 +53875,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52546,6 +53904,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52565,6 +53924,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -52636,6 +53996,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -52702,6 +54063,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -52836,6 +54198,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52855,10 +54218,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -52955,6 +54319,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52991,6 +54356,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -53051,6 +54417,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53178,7 +54545,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53271,6 +54641,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53334,7 +54705,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53363,6 +54734,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53382,6 +54754,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53514,7 +54887,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53607,6 +54983,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53670,7 +55047,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53699,6 +55076,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53718,6 +55096,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -53789,6 +55168,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53855,6 +55235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53989,6 +55370,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54006,12 +55388,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -54107,6 +55490,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54203,6 +55587,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54330,7 +55715,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54423,6 +55811,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54486,7 +55875,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54515,6 +55904,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54534,6 +55924,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -54666,7 +56057,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54759,6 +56153,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54822,7 +56217,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54851,6 +56246,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54870,6 +56266,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54941,6 +56338,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55007,6 +56405,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -55141,6 +56540,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55160,6 +56560,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -55223,6 +56624,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55242,9 +56644,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -55346,6 +56749,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55442,6 +56846,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55564,294 +56969,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** 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; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - }; - sha: string; - /** 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; - }; - body: string | null; - closed_at: string | null; - /** Format: uri */ - comments_url: string; - /** Format: uri */ - commits_url: string; - created_at: string; - /** Format: uri */ - diff_url: string; - draft: boolean; - head: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { /** - * @description Whether to allow auto-merge for pull requests. - * @default false + * Format: int64 + * @description Unique identifier of the repository */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55927,6 +57048,300 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + }; + sha: string; + /** 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; + /** Format: int64 */ + 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; + user_view_type?: string; + } | null; + }; + body: string | null; + closed_at: string | null; + /** Format: uri */ + comments_url: string; + /** Format: uri */ + commits_url: string; + created_at: string; + /** Format: uri */ + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** 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; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55992,6 +57407,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56011,6 +57427,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56082,6 +57499,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56148,6 +57566,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56282,6 +57701,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56301,11 +57721,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -56406,6 +57827,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56442,6 +57864,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -56502,6 +57925,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56629,7 +58053,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56722,6 +58149,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56778,7 +58206,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56807,6 +58235,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56826,6 +58255,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56965,7 +58395,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57058,6 +58491,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57121,7 +58555,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57150,6 +58584,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57169,6 +58604,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57236,6 +58672,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57283,6 +58720,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57351,6 +58789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -57491,6 +58930,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57510,6 +58950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -57549,8 +58990,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -57648,6 +59090,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57684,6 +59127,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -57744,6 +59188,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57871,7 +59316,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57964,6 +59412,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58027,7 +59476,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58056,6 +59505,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58075,6 +59525,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58214,7 +59665,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58307,6 +59761,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58370,7 +59825,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58399,6 +59854,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58418,6 +59874,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58485,6 +59942,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -58532,6 +59990,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -58600,6 +60059,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -58740,6 +60200,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58759,6 +60220,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -58817,7 +60279,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -58920,6 +60382,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58956,6 +60419,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -59016,6 +60480,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59143,7 +60608,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59236,6 +60704,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59299,7 +60768,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -59328,6 +60797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59347,6 +60817,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59486,7 +60957,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59579,6 +61053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59642,7 +61117,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -59671,6 +61146,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59690,6 +61166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59757,6 +61234,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -59804,6 +61282,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59872,6 +61351,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -60012,6 +61492,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60031,6 +61512,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -60070,8 +61552,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -60169,6 +61652,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60205,6 +61689,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -60265,6 +61750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60392,7 +61878,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60485,6 +61974,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60548,7 +62038,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60577,6 +62067,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60596,6 +62087,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -60735,7 +62227,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60828,6 +62323,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60891,7 +62387,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60920,6 +62416,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60939,6 +62436,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61006,6 +62504,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -61053,6 +62552,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61121,6 +62621,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61261,6 +62762,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61280,6 +62782,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -61338,7 +62841,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -61436,6 +62939,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61532,6 +63036,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61659,7 +63164,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61752,6 +63260,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61815,7 +63324,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61844,6 +63353,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61863,6 +63373,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61995,7 +63506,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62088,6 +63602,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62151,7 +63666,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62180,6 +63695,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62199,6 +63715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62270,6 +63787,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62336,6 +63854,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -62470,6 +63989,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62489,11 +64009,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -62589,6 +64110,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -62685,6 +64207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62812,301 +64335,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** 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; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; - /** 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; - }; - body: string | null; - closed_at: string | null; - /** Format: uri */ - comments_url: string; - /** Format: uri */ - commits_url: string; - created_at: string; - /** Format: uri */ - diff_url: string; - draft: boolean; - head: { - label: string | null; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false + * Format: int64 + * @description Unique identifier of the repository */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63182,6 +64414,307 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sha: string; + /** 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; + /** Format: int64 */ + 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; + user_view_type?: string; + } | null; + }; + body: string | null; + closed_at: string | null; + /** Format: uri */ + comments_url: string; + /** Format: uri */ + commits_url: string; + created_at: string; + /** Format: uri */ + diff_url: string; + draft: boolean; + head: { + label: string | null; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** 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; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63249,6 +64782,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63268,6 +64802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63339,6 +64874,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63405,6 +64941,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -63539,6 +65076,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63558,10 +65096,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -63691,6 +65230,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63710,6 +65250,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -63809,6 +65350,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63905,6 +65447,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64032,7 +65575,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64108,6 +65654,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64175,6 +65722,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64194,6 +65742,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64326,7 +65875,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64402,6 +65954,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64469,6 +66022,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64488,6 +66042,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -64559,6 +66114,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -64625,6 +66181,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -64759,6 +66316,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64778,10 +66336,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -64911,6 +66470,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64930,6 +66490,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -65033,6 +66594,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65129,6 +66691,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65256,7 +66819,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65349,6 +66915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65412,7 +66979,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65441,6 +67008,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65460,6 +67028,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -65599,7 +67168,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65685,6 +67257,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65748,7 +67321,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65777,6 +67350,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65796,6 +67370,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65863,6 +67438,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -65910,6 +67486,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65978,6 +67555,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -66118,6 +67696,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66137,10 +67716,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -66239,6 +67819,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66335,6 +67916,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66462,7 +68044,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66555,6 +68140,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66618,7 +68204,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66647,6 +68233,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66666,6 +68253,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66805,7 +68393,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66898,6 +68489,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66961,7 +68553,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66990,6 +68582,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67009,6 +68602,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67076,6 +68670,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -67123,6 +68718,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67191,6 +68787,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67331,6 +68928,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67350,10 +68948,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -67452,6 +69051,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67548,6 +69148,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67675,7 +69276,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67768,6 +69372,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67831,7 +69436,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -67860,6 +69465,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67879,6 +69485,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68018,7 +69625,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68104,6 +69714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68167,7 +69778,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68196,6 +69807,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68215,6 +69827,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68282,6 +69895,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -68329,6 +69943,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68397,6 +70012,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -68537,6 +70153,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68556,10 +70173,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -68657,6 +70275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -68753,6 +70372,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68880,7 +70500,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68973,6 +70596,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69036,7 +70660,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69065,6 +70689,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69084,6 +70709,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -69223,7 +70849,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69316,6 +70945,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69379,7 +71009,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69408,6 +71038,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69427,6 +71058,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69494,6 +71126,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69541,6 +71174,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -69609,6 +71243,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -69749,6 +71384,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69768,10 +71404,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -69780,7 +71417,7 @@ export interface components { base_ref: components["schemas"]["webhooks_nullable_string"]; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.11/rest/commits) to fetch additional commits. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.13/rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -69964,6 +71601,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -70025,7 +71666,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70101,6 +71745,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70150,7 +71795,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -70185,6 +71830,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -70207,6 +71853,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -70325,6 +71972,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -70355,7 +72003,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -70390,6 +72038,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -70412,6 +72061,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -70464,6 +72114,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -70488,7 +72139,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -70499,7 +72150,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -70510,7 +72161,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -70535,7 +72186,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -70546,7 +72197,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -70647,6 +72298,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -70695,7 +72347,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -70706,7 +72358,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -70717,7 +72369,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -70728,7 +72380,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-disabled": { /** @enum {string} */ @@ -70737,7 +72389,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-enabled": { /** @enum {string} */ @@ -70746,7 +72398,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -70756,7 +72408,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -70766,7 +72418,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -70776,7 +72428,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -70791,7 +72443,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -70815,7 +72467,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository privatized event */ "webhook-repository-privatized": { @@ -70825,7 +72477,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -70835,7 +72487,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -70852,7 +72504,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -70863,7 +72515,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -70874,7 +72526,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -70932,7 +72584,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -70983,6 +72635,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71002,6 +72655,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -71010,7 +72664,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -71020,7 +72674,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -71031,7 +72685,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -71084,6 +72738,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -71104,7 +72759,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -71115,7 +72770,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -71187,7 +72842,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -71198,7 +72853,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -71209,7 +72864,7 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { @@ -71225,7 +72880,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -71236,18 +72891,18 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - action: "revoked"; + action: "validated"; alert: components["schemas"]["secret-scanning-alert-webhook"]; 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"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -71258,7 +72913,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -71269,7 +72924,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -71285,6 +72940,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -71316,7 +72972,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -71329,7 +72985,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -71339,7 +72995,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -71350,7 +73006,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -71367,7 +73023,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -71379,7 +73035,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -71392,7 +73048,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -71404,7 +73060,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -71415,7 +73071,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -71427,7 +73083,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -71606,7 +73262,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -71624,7 +73280,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -71690,251 +73346,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** 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; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - team: components["schemas"]["webhooks_team_1"]; - }; - /** team created event */ - "webhook-team-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - /** - * Repository - * @description A git repository - */ - repository?: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; /** @description The default branch of the repository. */ default_branch: string; /** @@ -71991,7 +73406,263 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** 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; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + }; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; + }; + /** team created event */ + "webhook-team-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + /** + * Repository + * @description A git repository + */ + repository?: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72067,6 +73738,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72114,7 +73786,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -72180,6 +73852,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -72236,7 +73912,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72312,6 +73991,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72359,7 +74039,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -72456,6 +74136,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -72512,7 +74196,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72588,6 +74275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72635,7 +74323,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -72701,6 +74389,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -72757,7 +74449,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72833,6 +74528,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72880,7 +74576,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; "webhook-user-created": { @@ -72890,7 +74586,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; "webhook-user-deleted": { @@ -72900,7 +74596,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** watch started event */ @@ -72911,7 +74607,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -72923,7 +74619,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -72934,7 +74630,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -72955,7 +74651,7 @@ export interface components { /** Format: uri */ html_url: string; id: number; - /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.11/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ + /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.13/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ labels: string[]; name: string; node_id: string; @@ -73039,7 +74735,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -73052,7 +74748,7 @@ export interface components { /** Format: uri */ html_url: string; id: number; - /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.11/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ + /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.13/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ labels: string[]; name: string; node_id: string; @@ -73137,7 +74833,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -73191,7 +74887,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -73250,7 +74946,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -73290,6 +74986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -73309,6 +75006,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -73449,6 +75147,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -73623,6 +75322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -73697,6 +75397,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -73720,7 +75421,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -74184,7 +75885,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -74224,6 +75925,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -74384,6 +76086,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -74558,6 +76261,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -74632,6 +76336,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -74736,12 +76441,6 @@ export interface components { }; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ - code_scanning_forbidden_read: { - content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; /** @description Forbidden Gist */ forbidden_gist: { content: { @@ -74788,6 +76487,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response if GitHub Advanced Security is not enabled for this repository */ + code_scanning_forbidden_read: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { @@ -74851,9 +76556,9 @@ export interface components { }; }; parameters: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "per-page"?: number; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @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; @@ -74873,9 +76578,9 @@ export interface components { "pre-receive-hook-id": number; /** @description The unique identifier of the token. */ "token-id": number; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "pagination-before"?: string; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "pagination-after"?: string; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: string; @@ -74907,7 +76612,7 @@ export interface components { "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; - /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: @@ -74919,9 +76624,9 @@ export interface components { * The default is `web`. */ "audit-log-include"?: "web" | "git" | "all"; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ "audit-log-after"?: string; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -74975,19 +76680,18 @@ export interface components { "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ + /** @description A comma-separated list of secret types to return. By default all secret types are returned. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.13/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ "secret-scanning-alert-sort"?: "created" | "updated"; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ + "secret-scanning-alert-validity"?: string; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" + | "advanced_security_user_namespace" | "dependabot_alerts" | "secret_scanning" | "secret_scanning_push_protection"; @@ -75004,6 +76708,8 @@ export interface components { "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: string; + /** @description Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint. */ + "license-apply"?: boolean; /** @description The UUID which identifies a node. */ uuid?: string; /** @description The cluster roles from the cluster configuration file. */ @@ -75018,7 +76724,7 @@ export interface components { participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: string; - /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ "since-org"?: number; @@ -75028,16 +76734,20 @@ export interface components { "visible-to-repository"?: string; /** @description The name of the secret. */ "secret-name": string; - /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "variables-per-page"?: number; /** @description The name of the variable. */ "variable-name": string; - /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ "audit-log-phrase"?: string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The unique identifier of the group. */ "group-id": number; + /** @description The number of results per page for the "members" array (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-per-page"?: number; + /** @description The page number of the "members" array results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-page"?: number; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ @@ -75046,7 +76756,7 @@ export interface components { * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ "package-visibility"?: "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ @@ -75075,9 +76785,38 @@ 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 A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/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. */ + /** @description The custom property name */ + "custom-property-name": string; + /** + * @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + */ + "ruleset-targets"?: string; + /** @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 name of the repository to filter on. */ + "repository-name-in-query"?: string; + /** + * @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-server@3.13/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.13/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-server@3.13/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-server@3.11/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. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/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. */ "secret-scanning-pagination-after-org-repo"?: string; /** @description The slug of the team name. */ "team-slug": string; @@ -75132,7 +76871,7 @@ export interface components { actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ "workflow-run-branch"?: string; - /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.11/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ + /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.13/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ "workflow-run-status"?: @@ -75150,7 +76889,7 @@ export interface components { | "requested" | "waiting" | "pending"; - /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ + /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ "exclude-pull-requests"?: boolean; @@ -75166,7 +76905,7 @@ export interface components { "workflow-id": number | string; /** @description The unique identifier of the autolink. */ "autolink-id": number; - /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.11/graphql). */ + /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.13/graphql). */ branch: string; /** @description The unique identifier of the check run. */ "check-run-id": number; @@ -75218,6 +76957,8 @@ export interface components { "key-id": number; /** @description The number that identifies the milestone. */ "milestone-number": number; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ "pull-number": number; /** @description The unique identifier of the review. */ @@ -75252,6 +76993,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred"?: "created" | "updated"; + /** @description account_id parameter */ + "account-id": number; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user"?: number; }; @@ -75327,12 +77070,12 @@ export interface operations { url: string; /** @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. */ content_type?: string; - /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers) header. */ + /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers) header. */ secret?: string; /** @description Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** */ insecure_ssl?: string; }; - /** @description The [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ + /** @description The [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. @@ -75400,12 +77143,12 @@ export interface operations { url: string; /** @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. */ content_type?: string; - /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers) header. */ + /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers) header. */ secret?: string; /** @description Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** */ insecure_ssl?: string; }; - /** @description The [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ + /** @description The [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. @@ -75426,7 +77169,7 @@ export interface operations { }; /** * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the webhook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) to be sent to the webhook. */ "enterprise-admin/ping-global-webhook": { parameters: { @@ -75481,7 +77224,7 @@ export interface operations { }; /** * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. + * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ "enterprise-admin/update-ldap-mapping-for-team": { parameters: { @@ -75977,7 +77720,7 @@ export interface operations { }; /** * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * @@ -75992,7 +77735,7 @@ export interface operations { /** * @description **Required for built-in authentication.** The user's email * address. This parameter can be omitted when using CAS, LDAP, or SAML. - * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." + * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." */ email?: string; /** @@ -76014,7 +77757,7 @@ export interface operations { }; /** * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#suspend-a-user) is often a better option. + * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#suspend-a-user) is often a better option. * * You can delete any user account except your own. */ @@ -76068,7 +77811,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description A list of [scopes](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + /** @description A list of [scopes](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ scopes: string[]; }; }; @@ -76106,7 +77849,7 @@ export interface operations { * List global security advisories * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.13/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." */ "security-advisories/list-global-advisories": { parameters: { @@ -76139,28 +77882,38 @@ export interface operations { /** * @description If specified, only return advisories that were published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ published?: string; /** * @description If specified, only return advisories that were updated on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ updated?: string; /** * @description If specified, only show advisories that were updated or published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.13/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** + * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; }; responses: { @@ -76201,9 +77954,9 @@ export interface operations { }; /** * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-authenticated": { responses: { @@ -76217,7 +77970,7 @@ export interface operations { }; /** * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ "apps/create-from-manifest": { parameters: { @@ -76246,7 +77999,7 @@ export interface operations { * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-webhook-config-for-app": { responses: { @@ -76262,7 +78015,7 @@ export interface operations { * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/update-webhook-config-for-app": { requestBody: { @@ -76288,14 +78041,13 @@ export interface operations { * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/list-webhook-deliveries": { parameters: { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -76313,7 +78065,7 @@ export interface operations { * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-webhook-delivery": { parameters: { @@ -76336,7 +78088,7 @@ export interface operations { * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/redeliver-webhook-delivery": { parameters: { @@ -76817,7 +78569,7 @@ export interface operations { * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-installation": { parameters: { @@ -76837,9 +78589,9 @@ export interface operations { }; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/delete-installation": { parameters: { @@ -76863,9 +78615,7 @@ export interface operations { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/create-installation-access-token": { parameters: { @@ -76906,7 +78656,7 @@ export interface operations { * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/suspend-installation": { parameters: { @@ -76926,7 +78676,7 @@ export interface operations { * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/unsuspend-installation": { parameters: { @@ -76945,9 +78695,10 @@ export interface operations { /** * List your grants * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ "oauth-authorizations/list-grants": { parameters: { @@ -76977,7 +78728,8 @@ export interface operations { /** * Get a single grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ "oauth-authorizations/get-grant": { parameters: { @@ -77000,7 +78752,8 @@ export interface operations { /** * Delete a grant * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -77022,7 +78775,7 @@ export interface operations { }; /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ "apps/delete-authorization": { @@ -77049,7 +78802,7 @@ export interface operations { }; /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -77078,7 +78831,7 @@ export interface operations { }; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -77104,7 +78857,7 @@ export interface operations { }; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -77137,10 +78890,6 @@ export interface operations { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ "apps/scope-token": { parameters: { @@ -77194,7 +78943,8 @@ export interface operations { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ "apps/get-by-slug": { parameters: { @@ -77216,7 +78966,8 @@ export interface operations { /** * List your authorizations * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ "oauth-authorizations/list-authorizations": { parameters: { @@ -77246,17 +78997,19 @@ export interface operations { /** * Create a new authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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). * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.11/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.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * - * 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.11/articles/creating-an-access-token-for-command-line-use). + * 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.13/articles/creating-an-access-token-for-command-line-use). * - * 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.11/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. + * 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.13/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?: { @@ -77307,15 +79060,15 @@ export interface operations { /** * Get-or-create an authorization for a specific app * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * 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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ "oauth-authorizations/get-or-create-authorization-for-app": { parameters: { @@ -77359,7 +79112,10 @@ export interface operations { "application/json": components["schemas"]["authorization"]; }; }; - /** @description **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). */ + /** + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). + */ 201: { headers: { /** @example https://api.github.com/authorizations/1 */ @@ -77378,13 +79134,15 @@ export interface operations { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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.11/rest/overview/other-authentication-methods#working-with-two-factor-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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { parameters: { @@ -77443,7 +79201,8 @@ export interface operations { /** * Get a single authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ "oauth-authorizations/get-authorization": { parameters: { @@ -77466,7 +79225,8 @@ export interface operations { /** * Delete an authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). */ "oauth-authorizations/delete-authorization": { parameters: { @@ -77487,9 +79247,10 @@ export interface operations { /** * Update an existing authorization * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/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/). * - * 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.11/rest/overview/other-authentication-methods#working-with-two-factor-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.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * You can only send one of these scope keys at a time. */ @@ -78047,7 +79808,7 @@ export interface operations { * Get default workflow permissions for an enterprise * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -78070,7 +79831,7 @@ export interface operations { * Set default workflow permissions for an enterprise * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets * whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -78803,7 +80564,7 @@ export interface operations { }; /** * List code scanning alerts for an enterprise - * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be a member of the enterprise to use this endpoint. * @@ -78883,16 +80644,18 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.11/get-started/learning-about-github/about-github-advanced-security)." */ + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.13/get-started/learning-about-github/about-github-advanced-security)." */ advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.11/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." */ + /** @description Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.13/get-started/learning-about-github/about-github-advanced-security)." */ + advanced_security_enabled_new_user_namespace_repos?: boolean; + /** @description Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/about-secret-scanning)." */ + /** @description Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning)." */ secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ + /** @description Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** - * @description The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * @description The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; @@ -78917,7 +80680,7 @@ export interface operations { * * The authenticated user must be a member of the enterprise to use this endpoint. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ @@ -78957,7 +80720,7 @@ export interface operations { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. */ "secret-scanning/list-alerts-for-enterprise": { parameters: { @@ -78970,6 +80733,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { enterprise: components["parameters"]["enterprise"]; @@ -79014,7 +80778,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -79047,7 +80810,8 @@ export interface operations { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-public-events": { parameters: { @@ -79073,16 +80837,17 @@ export interface operations { * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -79124,7 +80889,8 @@ export interface operations { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ "gists/create": { requestBody: { @@ -79174,7 +80940,7 @@ export interface operations { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ "gists/list-public": { parameters: { @@ -79230,7 +80996,7 @@ export interface operations { * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -79326,7 +81092,7 @@ export interface operations { * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -79360,7 +81126,7 @@ export interface operations { * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -79402,7 +81168,7 @@ export interface operations { * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -79448,7 +81214,7 @@ export interface operations { * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -79582,7 +81348,7 @@ export interface operations { }; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "gists/star": { parameters: { @@ -79621,7 +81387,7 @@ export interface operations { * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -79647,7 +81413,7 @@ export interface operations { }; /** * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-for-the-authenticated-user). + * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ "gitignore/get-all-templates": { responses: { @@ -79664,7 +81430,7 @@ export interface operations { * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ @@ -79719,7 +81485,7 @@ export interface operations { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ "apps/revoke-installation-access-token": { responses: { @@ -79735,12 +81501,10 @@ export interface operations { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -79790,7 +81554,7 @@ export interface operations { }; /** * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ "licenses/get-all-commonly-used": { parameters: { @@ -79812,7 +81576,7 @@ export interface operations { }; /** * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ "licenses/get": { parameters: { @@ -79832,9 +81596,382 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get the configured SSH keys + * @description Gets the configured SSH keys on all available nodes. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/get-manage-ssh": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-ssh"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Set a new SSH key + * @description Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/set-manage-ssh": { + requestBody: { + content: { + "application/json": components["schemas"]["ghes-set-ssh-request"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-set-ssh-response"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Delete a SSH key + * @description Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/delete-manage-ssh": { + requestBody: { + content: { + "application/json": components["schemas"]["ghes-delete-ssh-request"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-delete-ssh-response"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the system requirement check results for configured cluster nodes + * @description Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + * This endpoint may take several seconds to reply. + */ + "enterprise-admin/get-checks-system-requirements": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-checks-system-requirements"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. + */ + "enterprise-admin/get-cluster-status": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-cluster-status"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + "enterprise-admin/get-manage-config-apply-status": { + parameters: { + query?: { + /** @description The unique run ID of the `ghe-config-apply` run. */ + run_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Whether the ghe-config-apply run is still running in the environment */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful in the environment */ + successful?: boolean; + nodes?: { + /** @description The unique Run ID of the ghe-config-apply run on the host */ + run_id?: string; + /** @description The hostname of the node */ + hostname?: string; + /** @description Whether the ghe-config-apply run is still running on the host */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful on the host */ + successful?: boolean; + }[]; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + "enterprise-admin/post-manage-run-config-apply": { + requestBody?: { + content: { + "application/json": { + /** @description The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly. */ + run_id?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Run ID the job was launched with */ + run_id?: string; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + "enterprise-admin/get-manage-config-apply-events": { + parameters: { + query?: { + /** @description The unique ID of the last response from a host, used for pagination. */ + last_request_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + nodes?: { + /** @description Hostname of the node */ + node?: string; + /** @description Unique ID of the last response from a host used for pagination */ + last_request_id?: string; + events?: { + timestamp?: string; + severity_text?: string; + body?: string; + event_name?: string; + topology?: string; + hostname?: string; + config_run_id?: string; + trace_id?: string; + span_id?: string; + span_parent_id?: string; + span_depth?: number; + }[]; + }[]; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + * + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + * + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + "enterprise-admin/initialize-instance-configuration": { + requestBody: { + content: { + "multipart/form-data": components["schemas"]["ghes-config-init-request"]; + }; + }; + responses: { + /** @description Response */ + 202: { + content: never; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the enterprise license information + * @description Gets information about the license that is currently set for the enterprise. + */ + "enterprise-admin/license-info": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-license-info"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Upload an enterprise license + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + "enterprise-admin/license-upload": { + parameters: { + query?: { + apply?: components["parameters"]["license-apply"]; + }; + }; + requestBody: { + content: { + "multipart/form-data": components["schemas"]["ghes-upload-license-request"]; + }; + }; + responses: { + /** @description Created */ + 201: { + content: never; + }; + /** @description Accepted */ + 202: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Check a license + * @description Check the status of the license that is currently set for the enterprise. + */ + "enterprise-admin/license-check": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-license-check"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; /** * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.11/admin/enterprise-management/configuring-clustering/about-clustering)." + * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.13/admin/enterprise-management/configuring-clustering/about-clustering)." */ "enterprise-admin/get-config-nodes": { parameters: { @@ -79860,9 +81997,65 @@ export interface operations { }; }; }; + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + "enterprise-admin/get-manage-settings": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-settings"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Set settings + * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-settings). + * + * **Notes:** + * - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + * - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + */ + "enterprise-admin/set-manage-settings": { + /** @description Only the settings parameters that should be modified need to be specified. */ + requestBody: { + content: { + "application/json": Record; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; /** * Get the status of maintenance mode - * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ "enterprise-admin/get-manage-maintenance": { parameters: { @@ -79894,7 +82087,7 @@ export interface operations { }; /** * Set the status of maintenance mode - * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ "enterprise-admin/set-manage-maintenance": { requestBody: { @@ -79954,7 +82147,7 @@ export interface operations { }; /** * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.11/admin/all-releases)." + * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.13/admin/all-releases)." */ "enterprise-admin/get-version": { parameters: { @@ -80051,7 +82244,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-repo-network": { parameters: { query?: { @@ -80088,7 +82285,7 @@ export interface operations { since?: components["parameters"]["since"]; before?: components["parameters"]["before"]; page?: components["parameters"]["page"]; - /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; }; @@ -80110,7 +82307,7 @@ export interface operations { }; /** * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ "activity/mark-notifications-as-read": { requestBody?: { @@ -80166,6 +82363,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications. + */ + "activity/mark-thread-as-done": { + parameters: { + path: { + thread_id: components["parameters"]["thread-id"]; + }; + }; + responses: { + /** @description No content */ + 204: { + content: never; + }; + }; + }; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. @@ -80187,7 +82401,7 @@ export interface operations { }; /** * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription). + * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ @@ -80215,7 +82429,7 @@ export interface operations { * * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ "activity/set-thread-subscription": { parameters: { @@ -80248,7 +82462,7 @@ export interface operations { }; /** * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ "activity/delete-thread-subscription": { parameters: { @@ -80290,7 +82504,8 @@ export interface operations { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ "orgs/list": { parameters: { @@ -80314,12 +82529,12 @@ export interface operations { }; }; /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * @@ -80352,21 +82567,10 @@ export interface operations { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.13/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -80395,7 +82599,7 @@ export interface operations { * * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.11/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.13/site-policy/github-terms/github-terms-of-service */ "orgs/delete": { parameters: { @@ -80411,21 +82615,11 @@ export interface operations { }; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. @@ -80468,15 +82662,15 @@ export interface operations { * @default true */ members_can_create_repositories?: boolean; - /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_internal_repositories?: boolean; - /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_private_repositories?: boolean; - /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -80498,49 +82692,49 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @description Whether Dependabot alerts is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @description Whether Dependabot security updates is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ @@ -80875,7 +83069,7 @@ export interface operations { * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -80898,7 +83092,7 @@ export interface operations { * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -81874,7 +84068,7 @@ export interface operations { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -81890,7 +84084,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -81906,7 +84100,7 @@ export interface operations { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -81935,7 +84129,7 @@ export interface operations { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -82311,11 +84505,11 @@ export interface operations { }; /** * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -82347,7 +84541,7 @@ export interface operations { }; /** * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an owner or security manager for the organization to use this endpoint. * @@ -82390,7 +84584,7 @@ export interface operations { }; /** * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -82420,7 +84614,7 @@ export interface operations { }; /** * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -82450,7 +84644,7 @@ export interface operations { }; /** * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -82476,7 +84670,7 @@ export interface operations { /** * Delete a custom repository role * @description Deletes a custom role from an organization. Once the custom role has been deleted, any - * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -82498,7 +84692,7 @@ export interface operations { }; /** * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -82814,7 +85008,7 @@ export interface operations { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -82828,7 +85022,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -82844,7 +85038,7 @@ export interface operations { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -82871,7 +85065,7 @@ export interface operations { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -82917,7 +85111,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-org-events": { parameters: { query?: { @@ -82941,10 +85139,14 @@ export interface operations { * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/external-idp-group-info-for-org": { parameters: { + query?: { + per_page?: components["parameters"]["members-per-page"]; + page?: components["parameters"]["members-page"]; + }; path: { org: components["parameters"]["org"]; group_id: components["parameters"]["group-id"]; @@ -82963,7 +85165,7 @@ export interface operations { * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/list-external-idp-groups-for-org": { parameters: { @@ -82993,7 +85195,9 @@ export interface operations { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -83053,7 +85257,7 @@ export interface operations { password?: string; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ * "push" * ] @@ -83111,7 +85315,9 @@ export interface operations { }; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -83162,7 +85368,7 @@ export interface operations { insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for. * @default [ * "push" * ] @@ -83263,7 +85469,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -83334,7 +85539,7 @@ export interface operations { }; /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) * to be sent to the hook. * * You must be an organization owner to use this endpoint. @@ -83361,7 +85566,7 @@ export interface operations { * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-org-installation": { parameters: { @@ -83416,12 +85621,10 @@ export interface operations { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -83572,13 +85775,13 @@ export interface operations { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.13/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ "orgs/set-membership-for-user": { parameters: { @@ -83668,7 +85871,7 @@ 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.11/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)." + * 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.13/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: { @@ -83814,7 +86017,7 @@ export interface operations { }; /** * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ "migrations/unlock-repo-for-org": { parameters: { @@ -83890,7 +86093,7 @@ export interface operations { }; /** * Convert an organization member to outside collaborator - * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.11/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.13/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ "orgs/convert-member-to-outside-collaborator": { parameters: { @@ -83921,7 +86124,7 @@ export interface operations { 204: { content: never; }; - /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ + /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ 403: { content: never; }; @@ -83959,7 +86162,7 @@ export interface operations { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-organization": { parameters: { @@ -83973,9 +86176,9 @@ export interface operations { | "nuget" | "container"; visibility?: components["parameters"]["package-visibility"]; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; path: { @@ -83998,7 +86201,7 @@ export interface operations { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-organization": { parameters: { @@ -84021,9 +86224,9 @@ export interface operations { * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-org": { parameters: { @@ -84051,9 +86254,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-org": { parameters: { @@ -84081,7 +86284,7 @@ export interface operations { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { @@ -84113,7 +86316,7 @@ export interface operations { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-organization": { parameters: { @@ -84137,9 +86340,9 @@ export interface operations { * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-org": { parameters: { @@ -84168,9 +86371,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-org": { parameters: { @@ -84626,6 +86829,206 @@ 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. + * Organization members can read these properties. + */ + "orgs/get-all-custom-properties": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "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"]["custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * Organization members can read these properties. + */ + "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"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "orgs/create-or-update-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["custom-property-set-payload"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "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"]; + /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.13/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + repository_query?: string; + }; + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + */ + "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 No Content when custom property values are successfully created or updated */ + 204: { + content: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. @@ -84678,7 +87081,7 @@ export interface operations { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "orgs/set-public-membership-for-authenticated-user": { parameters: { @@ -84717,7 +87120,8 @@ export interface operations { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/list-for-org": { parameters: { @@ -84781,7 +87185,7 @@ export interface operations { */ private?: boolean; /** - * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.11/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.13/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. * @enum {string} */ @@ -84821,7 +87225,7 @@ export interface operations { auto_init?: boolean; /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ gitignore_template?: string; - /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.11/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ + /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.13/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ license_template?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. @@ -84850,12 +87254,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -84872,7 +87278,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -84912,7 +87320,7 @@ export interface operations { }; /** * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -84942,6 +87350,7 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; }; path: { org: components["parameters"]["org"]; @@ -84976,15 +87385,21 @@ export interface operations { name: string; /** * @description The target of the ruleset. + * @default branch * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ rules?: components["schemas"]["repository-rule"][]; + /** + * @description The type of the source of the ruleset + * @enum {string} + */ + source_type?: "Repository" | "Organization"; }; }; }; @@ -84999,9 +87414,66 @@ 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-server@3.13/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + "repos/get-org-rule-suites": { + parameters: { + query?: { + ref?: components["parameters"]["ref-in-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-server@3.13/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. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-org-ruleset": { parameters: { @@ -85044,7 +87516,7 @@ export interface operations { * @description The target of the ruleset. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -85106,6 +87578,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { org: components["parameters"]["org"]; @@ -85127,7 +87600,7 @@ export interface operations { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * @@ -85150,7 +87623,7 @@ export interface operations { }; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -85176,7 +87649,7 @@ export interface operations { }; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -85223,7 +87696,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -85255,9 +87727,9 @@ export interface operations { }; /** * Create a team - * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.11/articles/setting-team-creation-permissions-in-your-organization)." + * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.13/articles/setting-team-creation-permissions-in-your-organization)." * - * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ "teams/create": { parameters: { @@ -85299,14 +87771,14 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ permission?: "pull" | "push"; /** @description The ID of a team to set as the parent team. */ parent_team_id?: number; - /** @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the "[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" endpoint to change the LDAP DN. For more information, see "[Using LDAP](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." */ + /** @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the "[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" endpoint to change the LDAP DN. For more information, see "[Using LDAP](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." */ ldap_dn?: string; }; }; @@ -85326,7 +87798,8 @@ export interface operations { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ "teams/get-by-name": { parameters: { @@ -85351,7 +87824,8 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ "teams/delete-in-org": { parameters: { @@ -85371,7 +87845,8 @@ export interface operations { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ "teams/update-in-org": { parameters: { @@ -85407,7 +87882,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -85439,7 +87914,8 @@ export interface operations { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -85473,9 +87949,10 @@ export interface operations { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85514,7 +87991,8 @@ export interface operations { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -85539,7 +88017,8 @@ export interface operations { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85562,7 +88041,8 @@ export interface operations { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85597,7 +88077,8 @@ export interface operations { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -85630,9 +88111,10 @@ export interface operations { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85665,7 +88147,8 @@ export interface operations { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -85691,7 +88174,8 @@ export interface operations { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85715,7 +88199,8 @@ export interface operations { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85747,16 +88232,17 @@ export interface operations { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: | "+1" | "-1" @@ -85790,11 +88276,12 @@ export interface operations { }; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85811,7 +88298,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: @@ -85843,9 +88330,10 @@ export interface operations { }; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85868,16 +88356,17 @@ export interface operations { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: | "+1" | "-1" @@ -85910,11 +88399,12 @@ export interface operations { }; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85930,7 +88420,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: @@ -85962,9 +88452,10 @@ export interface operations { }; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -85988,7 +88479,7 @@ export interface operations { * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/list-linked-external-idp-groups-to-team-for-org": { parameters: { @@ -86010,7 +88501,7 @@ export interface operations { * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { @@ -86030,7 +88521,7 @@ export interface operations { * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/link-external-idp-group-to-team-for-org": { parameters: { @@ -86096,12 +88587,13 @@ export interface operations { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#create-a-team). */ "teams/get-membership-for-user-in-org": { parameters: { @@ -86128,15 +88620,17 @@ export interface operations { * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -86179,11 +88673,13 @@ export interface operations { * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -86208,7 +88704,8 @@ export interface operations { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ "teams/list-projects-in-org": { parameters: { @@ -86237,7 +88734,8 @@ export interface operations { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -86264,7 +88762,8 @@ export interface operations { * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -86278,7 +88777,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -86305,7 +88804,8 @@ export interface operations { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/remove-project-in-org": { parameters: { @@ -86326,7 +88826,8 @@ export interface operations { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ "teams/list-repos-in-org": { parameters: { @@ -86355,13 +88856,14 @@ export interface operations { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/check-permissions-for-repo-in-org": { parameters: { @@ -86391,11 +88893,12 @@ export interface operations { }; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * - * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ "teams/add-or-update-repo-permissions-in-org": { parameters: { @@ -86409,10 +88912,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -86428,7 +88928,8 @@ export interface operations { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/remove-repo-in-org": { parameters: { @@ -86450,7 +88951,8 @@ export interface operations { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ "teams/list-child-in-org": { parameters: { @@ -86477,11 +88979,11 @@ export interface operations { }; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -87171,20 +89673,22 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.11/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.11/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.11/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.11/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.11/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions)." + * + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { responses: { @@ -87207,7 +89711,8 @@ export interface operations { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/get": { parameters: { @@ -87264,7 +89769,7 @@ export interface operations { }; /** * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#replace-all-repository-topics) endpoint. + * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#replace-all-repository-topics) endpoint. */ "repos/update": { parameters: { @@ -87284,7 +89789,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.13/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -87296,7 +89801,7 @@ export interface operations { /** * @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. @@ -87369,12 +89874,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -87391,7 +89898,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -87969,8 +90478,8 @@ export interface operations { * Get the level of access for workflows outside of the repository * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -87994,8 +90503,8 @@ export interface operations { * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -88073,7 +90582,7 @@ export interface operations { * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -88097,7 +90606,7 @@ export interface operations { * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -88463,13 +90972,13 @@ export interface operations { }; /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs-for-repo": { parameters: { @@ -88647,7 +91156,7 @@ export interface operations { /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -88737,10 +91246,10 @@ export interface operations { }; /** * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -88766,10 +91275,35 @@ 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). + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope 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. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -89086,7 +91620,7 @@ export interface operations { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -89103,7 +91637,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -89434,11 +91968,13 @@ export interface operations { }; /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs": { parameters: { @@ -89480,7 +92016,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 activity and data for your repository](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository)." + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.13/repositories/viewing-activity-and-data-for-your-repository)." */ "repos/list-activities": { parameters: { @@ -89536,7 +92072,7 @@ export interface operations { }; /** * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.11/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.13/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ "issues/list-assignees": { parameters: { @@ -89701,7 +92237,7 @@ export interface operations { }; /** * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.11/articles/configuring-automated-security-fixes)". + * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.13/articles/configuring-automated-security-fixes)". */ "repos/check-automated-security-fixes": { parameters: { @@ -89711,13 +92247,13 @@ export interface operations { }; }; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { content: never; }; @@ -89727,7 +92263,7 @@ export interface operations { "repos/list-branches": { parameters: { query?: { - /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -89772,7 +92308,7 @@ export interface operations { }; /** * Get branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-branch-protection": { parameters: { @@ -89794,13 +92330,15 @@ export interface operations { }; /** * Update branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ "repos/update-branch-protection": { parameters: { @@ -89819,7 +92357,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -89845,7 +92383,7 @@ export interface operations { }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ dismiss_stale_reviews?: boolean; - /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.11/articles/about-code-owners/) review them. */ + /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.13/articles/about-code-owners/) review them. */ require_code_owner_reviews?: boolean; /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ required_approving_review_count?: number; @@ -89873,11 +92411,11 @@ export interface operations { /** @description The list of app `slug`s with push access */ apps?: string[]; } | null; - /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ + /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ allow_force_pushes?: boolean | null; - /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ + /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ allow_deletions?: boolean; /** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */ block_creations?: boolean; @@ -89910,7 +92448,7 @@ export interface operations { }; /** * Delete branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/delete-branch-protection": { parameters: { @@ -89930,7 +92468,7 @@ export interface operations { }; /** * Get admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-admin-branch-protection": { parameters: { @@ -89951,7 +92489,7 @@ export interface operations { }; /** * Set admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -89974,7 +92512,7 @@ export interface operations { }; /** * Delete admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -89996,7 +92534,7 @@ export interface operations { }; /** * Get pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-pull-request-review-protection": { parameters: { @@ -90017,7 +92555,7 @@ export interface operations { }; /** * Delete pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/delete-pull-request-review-protection": { parameters: { @@ -90037,11 +92575,12 @@ export interface operations { }; /** * Update pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ "repos/update-pull-request-review-protection": { parameters: { @@ -90065,7 +92604,7 @@ export interface operations { }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ dismiss_stale_reviews?: boolean; - /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.11/articles/about-code-owners/) have reviewed. */ + /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.13/articles/about-code-owners/) have reviewed. */ require_code_owner_reviews?: boolean; /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ required_approving_review_count?: number; @@ -90098,11 +92637,12 @@ export interface operations { }; /** * Get commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.11/articles/signing-commits-with-gpg) in GitHub Help. + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.13/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ "repos/get-commit-signature-protection": { parameters: { @@ -90124,7 +92664,7 @@ export interface operations { }; /** * Create commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -90148,7 +92688,7 @@ export interface operations { }; /** * Delete commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -90170,7 +92710,7 @@ export interface operations { }; /** * Get status checks protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-status-checks-protection": { parameters: { @@ -90192,7 +92732,7 @@ export interface operations { }; /** * Remove status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/remove-status-check-protection": { parameters: { @@ -90211,7 +92751,7 @@ export interface operations { }; /** * Update status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -90230,7 +92770,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -90256,7 +92796,7 @@ export interface operations { }; /** * Get all status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-all-status-check-contexts": { parameters: { @@ -90278,7 +92818,7 @@ export interface operations { }; /** * Set status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/set-status-check-contexts": { parameters: { @@ -90309,7 +92849,7 @@ export interface operations { }; /** * Add status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/add-status-check-contexts": { parameters: { @@ -90341,7 +92881,7 @@ export interface operations { }; /** * Remove status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/remove-status-check-contexts": { parameters: { @@ -90372,11 +92912,12 @@ export interface operations { }; /** * Get access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ "repos/get-access-restrictions": { parameters: { @@ -90398,7 +92939,7 @@ export interface operations { }; /** * Delete access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -90419,7 +92960,7 @@ export interface operations { }; /** * Get apps with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -90443,7 +92984,7 @@ export interface operations { }; /** * Set app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -90455,7 +92996,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -90475,7 +93016,7 @@ export interface operations { }; /** * Add app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -90487,7 +93028,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -90507,7 +93048,7 @@ export interface operations { }; /** * Remove app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -90519,7 +93060,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -90539,7 +93080,7 @@ export interface operations { }; /** * Get teams with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ @@ -90563,7 +93104,7 @@ export interface operations { }; /** * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ @@ -90595,7 +93136,7 @@ export interface operations { }; /** * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ @@ -90627,7 +93168,7 @@ export interface operations { }; /** * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ @@ -90659,7 +93200,7 @@ export interface operations { }; /** * Get users with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ @@ -90683,7 +93224,7 @@ export interface operations { }; /** * Set user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -90699,7 +93240,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -90719,7 +93260,7 @@ export interface operations { }; /** * Add user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -90735,7 +93276,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -90755,7 +93296,7 @@ export interface operations { }; /** * Remove user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -90771,7 +93312,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -90793,7 +93334,8 @@ export interface operations { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.11/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.13/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -90950,7 +93492,8 @@ export interface operations { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -90975,7 +93518,8 @@ export interface operations { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -91039,7 +93583,7 @@ export interface operations { summary: string; /** @description Can contain Markdown. */ text?: string; - /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.11/articles/about-status-checks#checks)". */ + /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.13/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.13/articles/about-status-checks#checks)". */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ path: string; @@ -91073,7 +93617,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.11/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.13/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -91137,9 +93681,9 @@ export interface operations { }; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -91175,9 +93719,10 @@ export interface operations { }; /** * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#update-repository-preferences-for-check-suites)". + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.13/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -91213,7 +93758,7 @@ export interface operations { }; /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#create-a-check-suite). + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ "checks/set-suites-preferences": { @@ -91252,7 +93797,8 @@ export interface operations { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -91277,7 +93823,8 @@ export interface operations { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -91314,7 +93861,7 @@ export interface operations { }; /** * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -91484,8 +94031,8 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -91535,7 +94082,7 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * @@ -91722,7 +94269,7 @@ export interface operations { }; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -91735,7 +94282,7 @@ export interface operations { * ``` * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -91754,6 +94301,8 @@ export interface operations { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -91840,7 +94389,7 @@ export interface operations { * file. * * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * see "[About code owners](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ "repos/codeowners-errors": { parameters: { @@ -91936,17 +94485,17 @@ export interface operations { }; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Updating an existing collaborator's permission level** * @@ -92003,11 +94552,12 @@ export interface operations { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.13/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ "repos/remove-collaborator": { parameters: { @@ -92058,7 +94608,7 @@ export interface operations { * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -92092,7 +94642,7 @@ export interface operations { * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -92138,7 +94688,7 @@ export interface operations { * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -92173,12 +94723,12 @@ export interface operations { }; /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). + * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment). */ "reactions/list-for-commit-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ content?: | "+1" | "-1" @@ -92212,7 +94762,7 @@ export interface operations { }; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ "reactions/create-for-commit-comment": { parameters: { @@ -92226,7 +94776,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the commit comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the commit comment. * @enum {string} */ content: @@ -92259,9 +94809,10 @@ export interface operations { }; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.13/rest/commits/comments#get-a-commit-comment). */ "reactions/delete-for-commit-comment": { parameters: { @@ -92291,6 +94842,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -92321,8 +94873,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - since?: components["parameters"]["since"]; - /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -92350,7 +94903,7 @@ export interface operations { }; /** * List branches for HEAD commit - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -92377,7 +94930,7 @@ export interface operations { * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -92412,9 +94965,9 @@ export interface operations { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -92438,7 +94991,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -92493,9 +95046,10 @@ export interface operations { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -92511,6 +95065,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -92560,9 +95115,10 @@ export interface operations { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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.11/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.11/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * 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.13/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.13/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -92602,7 +95158,8 @@ export interface operations { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -92705,11 +95262,11 @@ export interface operations { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.13/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.diff`**: Returns the diff of the commit. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -92722,10 +95279,10 @@ export interface operations { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api)." * * **Signature verification object** * @@ -92737,6 +95294,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -92785,7 +95343,7 @@ export interface operations { * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -92799,9 +95357,9 @@ export interface operations { * * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.13/rest/git/trees#get-a-tree). * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.13/rest/git/trees#get-a-tree). * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. * - If the requested file's size is: * - 1 MB or smaller: All features of this endpoint are supported. @@ -92835,6 +95393,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -92843,7 +95402,8 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.13/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -92902,7 +95462,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -92916,7 +95483,8 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.13/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -93020,12 +95588,12 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** * @deprecated - * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; before?: components["parameters"]["pagination-before"]; @@ -93078,7 +95646,7 @@ export interface operations { }; /** * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -93211,7 +95779,7 @@ export interface operations { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -93226,7 +95794,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -93411,7 +95979,7 @@ export interface operations { * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) for every submitted context must be in a `success` + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.13/rest/commits/statuses) for every submitted context must be in a `success` * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do * not require any contexts or create any commit statuses, the deployment will always succeed. @@ -93468,7 +96036,7 @@ export interface operations { * @default true */ auto_merge?: boolean; - /** @description The [status](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ + /** @description The [status](https://docs.github.com/enterprise-server@3.13/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; payload?: OneOf< [ @@ -93548,7 +96116,7 @@ export interface operations { * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * * Mark the active deployment as inactive by adding any non-successful deployment status. * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.13/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.13/rest/deployments/statuses#create-a-deployment-status)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ @@ -93628,7 +96196,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -93693,7 +96264,7 @@ export interface operations { }; /** * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#repository_dispatch)." + * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#repository_dispatch)." * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * @@ -93713,7 +96284,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -93766,7 +96337,8 @@ export interface operations { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -93793,9 +96365,11 @@ export interface operations { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -93899,7 +96473,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -93935,7 +96509,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. * @@ -93961,7 +96535,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -93990,7 +96564,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -94012,9 +96586,9 @@ export interface operations { }; /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -94048,7 +96622,7 @@ export interface operations { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -94079,11 +96653,13 @@ export interface operations { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app)". * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -94117,9 +96693,9 @@ export interface operations { }; /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.13/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -94256,7 +96832,7 @@ export interface operations { /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -94274,7 +96850,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#get-an-environment-public-key) endpoint. */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -94474,7 +97050,8 @@ export interface operations { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-repo-events": { parameters: { @@ -94527,9 +97104,11 @@ export interface operations { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ "repos/create-fork": { parameters: { @@ -94598,14 +97177,21 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw blob data. * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -94647,6 +97233,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -94680,7 +97267,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -94743,6 +97330,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -94787,7 +97375,8 @@ export interface operations { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -94816,7 +97405,8 @@ export interface operations { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ "git/get-ref": { parameters: { @@ -94932,7 +97522,7 @@ export interface operations { }; /** * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.13/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.13/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * * **Signature verification object** * @@ -94944,6 +97534,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95026,6 +97617,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95068,7 +97660,7 @@ export interface operations { * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.11/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.11/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.13/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.13/rest/git/refs#update-a-reference)." * * Returns an error if you try to delete a file that does not exist. */ @@ -95140,8 +97732,8 @@ export interface operations { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ "git/get-tree": { parameters: { @@ -95221,7 +97813,7 @@ export interface operations { insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for. * @default [ * "push" * ] @@ -95273,7 +97865,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -95307,7 +97904,7 @@ export interface operations { "application/json": { config?: components["schemas"]["webhook-config"]; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ * "push" * ] @@ -95401,7 +97998,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -95465,7 +98061,7 @@ export interface operations { }; /** * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) to be sent to the hook. */ "repos/ping-webhook": { parameters: { @@ -95487,7 +98083,8 @@ export interface operations { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ "repos/test-push-webhook": { parameters: { @@ -95509,7 +98106,7 @@ export interface operations { * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-repo-installation": { parameters: { @@ -95605,12 +98202,10 @@ export interface operations { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95660,12 +98255,12 @@ export interface operations { }; /** * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.11/articles/disabling-issues/), the API returns a `410 Gone` status. + * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.13/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95686,7 +98281,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: string | number | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -95731,7 +98326,7 @@ export interface operations { * * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95771,7 +98366,7 @@ export interface operations { * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95819,7 +98414,7 @@ export interface operations { * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95854,12 +98449,12 @@ export interface operations { }; /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). + * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment). */ "reactions/list-for-issue-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ content?: | "+1" | "-1" @@ -95893,7 +98488,7 @@ export interface operations { }; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ "reactions/create-for-issue-comment": { parameters: { @@ -95907,7 +98502,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the issue comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the issue comment. * @enum {string} */ content: @@ -95940,9 +98535,10 @@ export interface operations { }; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment). */ "reactions/delete-for-issue-comment": { parameters: { @@ -96014,19 +98610,17 @@ export interface operations { }; /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.11/articles/transferring-an-issue-to-another-repository/) to another repository. If + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + * [transferred](https://docs.github.com/enterprise-server@3.13/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - * to the [`issues`](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#issues) webhook. + * to the [`issues`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96056,9 +98650,9 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96080,7 +98674,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -96220,7 +98814,7 @@ export interface operations { * * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96258,12 +98852,12 @@ export interface operations { * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96380,7 +98974,7 @@ export interface operations { "application/json": OneOf< [ { - /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.11/rest/issues/labels#add-labels-to-an-issue)." */ + /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.13/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; }, { @@ -96422,7 +99016,7 @@ export interface operations { "application/json": OneOf< [ { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.11/rest/issues/labels#set-labels-for-an-issue)." */ + /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.13/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; }, { @@ -96498,7 +99092,7 @@ export interface operations { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "issues/lock": { parameters: { @@ -96557,12 +99151,12 @@ export interface operations { }; /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). + * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). */ "reactions/list-for-issue": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ content?: | "+1" | "-1" @@ -96597,7 +99191,7 @@ export interface operations { }; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ "reactions/create-for-issue": { parameters: { @@ -96611,7 +99205,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the issue. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the issue. * @enum {string} */ content: @@ -96644,9 +99238,10 @@ export interface operations { }; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). */ "reactions/delete-for-issue": { parameters: { @@ -96739,7 +99334,7 @@ export interface operations { /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.11/articles/permission-levels-for-a-user-account-repository/)." + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.13/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.13/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; @@ -97008,13 +99603,16 @@ export interface operations { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ "licenses/get-for-repo": { parameters: { + query?: { + ref?: components["parameters"]["git-ref"]; + }; path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; @@ -97332,7 +99930,7 @@ export interface operations { }; /** * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ "activity/mark-repo-notifications-as-read": { parameters: { @@ -97409,7 +100007,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.11/articles/using-a-custom-domain-with-github-pages/)." */ + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.13/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -97656,6 +100254,49 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + "repos/get-pages-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["pages-deployment-status"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + "repos/cancel-pages-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List pre-receive hooks for a repository * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. @@ -97824,6 +100465,61 @@ 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 read 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"]; + }; + }; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + "repos/create-or-update-custom-properties-values": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + responses: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { + content: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List pull requests * @description Lists pull requests in a specified repository. @@ -97831,10 +100527,10 @@ export interface operations { * 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-server@3.11/github/getting-started-with-github/githubs-products) + * Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97878,13 +100574,13 @@ export interface operations { }; /** * Create a pull request - * @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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97915,9 +100611,9 @@ export interface operations { base: string; /** @description The contents of the pull request. */ body?: string; - /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.11/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.13/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ maintainer_can_modify?: boolean; - /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/enterprise-server@3.11/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ + /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/enterprise-server@3.13/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** * Format: int64 @@ -97948,7 +100644,7 @@ export interface operations { * @description Lists review comments for all pull requests in a repository. By default, * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97986,7 +100682,7 @@ export interface operations { * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98035,7 +100731,7 @@ export interface operations { * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98069,12 +100765,12 @@ 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.11/rest/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.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ content?: | "+1" | "-1" @@ -98108,7 +100804,7 @@ export interface operations { }; /** * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ "reactions/create-for-pull-request-review-comment": { parameters: { @@ -98122,7 +100818,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the pull request review comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the pull request review comment. * @enum {string} */ content: @@ -98155,9 +100851,10 @@ export interface operations { }; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/delete-for-pull-request-comment": { parameters: { @@ -98177,23 +100874,23 @@ export interface operations { }; /** * Get a pull request - * @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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.13/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98210,7 +100907,7 @@ export interface operations { }; }; responses: { - /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ + /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -98225,11 +100922,11 @@ export interface operations { }; /** * Update a pull request - * @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-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98258,7 +100955,7 @@ export interface operations { state?: "open" | "closed"; /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ base?: string; - /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.11/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.13/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ maintainer_can_modify?: boolean; }; }; @@ -98279,7 +100976,7 @@ export interface operations { * @description Lists all review comments for a specified pull request. By default, review comments * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98316,16 +101013,16 @@ export interface operations { }; /** * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#create-an-issue-comment)." + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.13/rest/issues/comments#create-an-issue-comment)." * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98351,20 +101048,20 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** - * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/enterprise-server@3.11/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/enterprise-server@3.13/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ side?: "LEFT" | "RIGHT"; /** @description **Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ line?: number; - /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ + /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ start_line?: number; /** - * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.11/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.13/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ start_side?: "LEFT" | "RIGHT" | "side"; @@ -98400,10 +101097,10 @@ export interface operations { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98444,10 +101141,10 @@ export interface operations { /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits) + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits) * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98482,10 +101179,10 @@ export interface operations { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98545,7 +101242,7 @@ export interface operations { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." */ "pulls/merge": { parameters: { @@ -98604,7 +101301,7 @@ export interface operations { }; /** * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { @@ -98698,7 +101395,7 @@ export interface operations { * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98733,15 +101430,16 @@ export interface operations { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98764,7 +101462,7 @@ export interface operations { /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ body?: string; /** - * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. + * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; @@ -98803,7 +101501,7 @@ export interface operations { * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98833,7 +101531,7 @@ export interface operations { * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98871,7 +101569,7 @@ export interface operations { * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98902,7 +101600,7 @@ export interface operations { * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98939,11 +101637,10 @@ export interface operations { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.13/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -98985,9 +101682,9 @@ export interface operations { }; /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -99031,6 +101728,7 @@ export interface operations { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -99043,7 +101741,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ + /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ expected_head_sha?: string; } | null; }; @@ -99066,7 +101764,7 @@ export interface operations { * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -99089,6 +101787,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -99097,7 +101796,7 @@ export interface operations { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -99128,7 +101827,7 @@ export interface operations { }; /** * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-tags). + * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ @@ -99160,7 +101859,7 @@ export interface operations { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." */ "repos/create-release": { parameters: { @@ -99220,7 +101919,13 @@ export interface operations { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ "repos/get-release-asset": { parameters: { @@ -99292,7 +101997,7 @@ export interface operations { }; /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ "repos/generate-release-notes": { parameters: { @@ -99374,9 +102079,8 @@ export interface operations { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ "repos/get-release": { parameters: { @@ -99387,7 +102091,7 @@ export interface operations { }; }; responses: { - /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ + /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { content: { "application/json": components["schemas"]["release"]; @@ -99490,8 +102194,8 @@ export interface operations { }; /** * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#create-a-release) to upload a release asset. + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * @@ -99505,9 +102209,9 @@ export interface operations { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.11/rest/releases/assets#list-release-assets)" + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.13/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-the-latest-release). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ "repos/upload-release-asset": { @@ -99542,12 +102246,12 @@ export interface operations { }; /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). + * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). */ "reactions/list-for-release": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -99573,7 +102277,7 @@ export interface operations { }; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ "reactions/create-for-release": { parameters: { @@ -99587,7 +102291,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the release. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the release. * @enum {string} */ content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; @@ -99612,9 +102316,10 @@ export interface operations { }; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release). */ "reactions/delete-for-release": { parameters: { @@ -99709,6 +102414,7 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; }; path: { owner: components["parameters"]["owner"]; @@ -99744,10 +102450,11 @@ export interface operations { /** @description The name of the ruleset. */ name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * @default branch * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -99768,9 +102475,67 @@ 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-server@3.13/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-server@3.13/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. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-repo-ruleset": { parameters: { @@ -99816,10 +102581,10 @@ export interface operations { /** @description The name of the ruleset. */ name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -99882,6 +102647,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { owner: components["parameters"]["owner"]; @@ -100021,7 +102787,7 @@ export interface operations { * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -100280,7 +103046,7 @@ export interface operations { }; /** * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#delete-a-repository-subscription) completely. + * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#delete-a-repository-subscription) completely. */ "activity/set-repo-subscription": { parameters: { @@ -100310,7 +103076,7 @@ export interface operations { }; /** * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#set-a-repository-subscription). + * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.13/rest/activity/watching#set-a-repository-subscription). */ "activity/delete-repo-subscription": { parameters: { @@ -100351,8 +103117,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -100375,8 +103145,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -100406,8 +103180,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -100432,7 +103210,9 @@ export interface operations { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -100518,7 +103298,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -100536,7 +103316,7 @@ export interface operations { }; /** * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.11/articles/about-repository-transfers/). + * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.13/articles/about-repository-transfers/). */ "repos/transfer": { parameters: { @@ -100568,7 +103348,7 @@ export interface operations { }; /** * Check if vulnerability alerts are enabled for a repository - * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/check-vulnerability-alerts": { parameters: { @@ -100590,7 +103370,7 @@ export interface operations { }; /** * Enable vulnerability alerts - * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/enable-vulnerability-alerts": { parameters: { @@ -100610,7 +103390,7 @@ export interface operations { * Disable vulnerability alerts * @description Disables dependency alerts for a repository. * The authenticated user must have admin access to the repository. For more information, - * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/disable-vulnerability-alerts": { parameters: { @@ -100632,7 +103412,8 @@ export interface operations { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ "repos/download-zipball-archive": { parameters: { @@ -100655,7 +103436,7 @@ export interface operations { }; /** * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ @@ -100709,7 +103490,7 @@ export interface operations { * * Note: * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ "repos/list-public": { parameters: { @@ -100736,7 +103517,8 @@ export interface operations { }; /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -100771,7 +103553,8 @@ export interface operations { }; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -100805,7 +103588,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ @@ -100836,7 +103620,8 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -100872,9 +103657,10 @@ export interface operations { }; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { @@ -100898,7 +103684,8 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -100940,7 +103727,8 @@ export interface operations { }; /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -100974,7 +103762,8 @@ export interface operations { }; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -101010,7 +103799,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ @@ -101038,13 +103828,15 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { @@ -101076,7 +103868,8 @@ export interface operations { }; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ @@ -101102,25 +103895,28 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { @@ -101152,9 +103948,9 @@ export interface operations { }; /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -101174,9 +103970,9 @@ export interface operations { "search/code": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; @@ -101203,10 +103999,10 @@ export interface operations { }; /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -101215,9 +104011,9 @@ export interface operations { "search/commits": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101240,10 +104036,10 @@ export interface operations { }; /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -101251,14 +104047,15 @@ export interface operations { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.11/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.13/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ "search/issues-and-pull-requests": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results) */ sort?: | "comments" | "reactions" @@ -101295,9 +104092,9 @@ export interface operations { }; /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -101310,9 +104107,9 @@ export interface operations { query: { /** @description The id of the repository. */ repository_id: number; - /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). */ + /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). */ q: string; - /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101338,9 +104135,9 @@ export interface operations { }; /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -101351,9 +104148,9 @@ export interface operations { "search/repos": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.11/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.13/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101378,9 +104175,9 @@ export interface operations { }; /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.11/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.13/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -101391,7 +104188,7 @@ export interface operations { "search/topics": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). */ q: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -101413,9 +104210,9 @@ export interface operations { }; /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -101423,14 +104220,14 @@ export interface operations { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.11/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.13/graphql/reference/queries#search)." */ "search/users": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/enterprise-server@3.11/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -101518,7 +104315,8 @@ export interface operations { }; /** * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * @description > [!NOTE] + * > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ "enterprise-admin/enable-or-disable-maintenance-mode": { requestBody: { @@ -101550,9 +104348,10 @@ export interface operations { }; /** * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#set-settings). + * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * > [!NOTE] + * > You cannot retrieve the management console password with the Enterprise administration API. */ "enterprise-admin/get-settings": { responses: { @@ -101570,18 +104369,18 @@ export interface operations { }; /** * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings). + * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). * * **Notes:** * * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." */ "enterprise-admin/set-settings": { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings). */ + /** @description A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). */ settings: string; }; }; @@ -101668,14 +104467,15 @@ export interface operations { * Create a GitHub license * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/create-enterprise-server-license": { requestBody: { @@ -101685,7 +104485,7 @@ export interface operations { license: string; /** @description You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. */ password?: string; - /** @description An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings). */ + /** @description An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). */ settings?: string; }; }; @@ -101705,7 +104505,8 @@ export interface operations { * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/upgrade-license": { requestBody?: { @@ -101730,7 +104531,8 @@ export interface operations { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#get-a-team-by-name) endpoint. */ "teams/get-legacy": { parameters: { @@ -101751,7 +104553,8 @@ export interface operations { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -101775,11 +104578,13 @@ export interface operations { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -101814,7 +104619,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -101845,7 +104650,8 @@ export interface operations { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -101877,11 +104683,12 @@ export interface operations { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -101918,7 +104725,8 @@ export interface operations { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -101943,7 +104751,8 @@ export interface operations { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -101966,7 +104775,8 @@ export interface operations { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -102001,7 +104811,8 @@ export interface operations { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -102034,11 +104845,12 @@ export interface operations { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -102069,7 +104881,8 @@ export interface operations { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -102095,7 +104908,8 @@ export interface operations { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -102119,7 +104933,8 @@ export interface operations { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -102153,16 +104968,17 @@ export interface operations { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: | "+1" | "-1" @@ -102196,9 +105012,10 @@ export interface operations { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * @@ -102216,7 +105033,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: @@ -102243,16 +105060,17 @@ export interface operations { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: | "+1" | "-1" @@ -102285,9 +105103,10 @@ export interface operations { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * @@ -102304,7 +105123,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: @@ -102331,7 +105150,8 @@ export interface operations { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.11/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.13/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -102363,9 +105183,9 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. */ @@ -102390,17 +105210,18 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "teams/add-member-legacy": { parameters: { @@ -102428,15 +105249,16 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-member-legacy": { parameters: { @@ -102459,7 +105281,8 @@ export interface operations { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -102468,7 +105291,7 @@ export interface operations { * **Note:** * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#create-a-team). */ "teams/get-membership-for-user-legacy": { parameters: { @@ -102490,13 +105313,15 @@ export interface operations { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -102542,13 +105367,15 @@ export interface operations { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.13/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.13/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-membership-for-user-legacy": { parameters: { @@ -102571,7 +105398,8 @@ export interface operations { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -102601,7 +105429,8 @@ export interface operations { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -102628,7 +105457,8 @@ export interface operations { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -102643,7 +105473,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -102671,7 +105501,8 @@ export interface operations { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -102694,7 +105525,8 @@ export interface operations { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-repositories) endpoint. */ "teams/list-repos-legacy": { parameters: { @@ -102722,11 +105554,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -102756,11 +105590,12 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "teams/add-or-update-repo-permissions-legacy": { parameters: { @@ -102793,7 +105628,8 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -102815,7 +105651,8 @@ export interface operations { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-child-teams) endpoint. */ "teams/list-child-legacy": { parameters: { @@ -103098,7 +105935,7 @@ export interface operations { }; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ @@ -103117,6 +105954,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -103322,6 +106160,8 @@ export interface operations { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -103343,6 +106183,8 @@ export interface operations { /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -103369,12 +106211,10 @@ export interface operations { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -103777,6 +106617,9 @@ export interface operations { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -103804,7 +106647,7 @@ export interface operations { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-authenticated-user": { parameters: { @@ -103836,7 +106679,7 @@ export interface operations { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-authenticated-user": { parameters: { @@ -103858,7 +106701,7 @@ export interface operations { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-authenticated-user": { parameters: { @@ -103885,7 +106728,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-authenticated-user": { parameters: { @@ -103912,7 +106755,7 @@ export interface operations { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { @@ -103943,7 +106786,7 @@ export interface operations { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-authenticated-user": { parameters: { @@ -103968,7 +106811,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-authenticated-user": { parameters: { @@ -103996,7 +106839,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-authenticated-user": { parameters: { @@ -104053,7 +106896,7 @@ export interface operations { /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) * endpoint. * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -104220,7 +107063,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -104237,7 +107082,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -104483,7 +107330,7 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.11/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.13/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ key: string; }; }; @@ -104554,7 +107401,7 @@ export interface operations { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -104612,7 +107459,7 @@ export interface operations { }; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "activity/star-repo-for-authenticated-user": { parameters: { @@ -104711,11 +107558,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.13/rest/users/emails)". + */ + "users/get-by-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ "users/list": { parameters: { @@ -104742,9 +107615,9 @@ export interface operations { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.11/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.13/rest/users/emails)". */ "users/get-by-username": { parameters: { @@ -104789,7 +107662,10 @@ export interface operations { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-events-for-authenticated-user": { parameters: { @@ -104813,6 +107689,9 @@ export interface operations { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-org-events-for-authenticated-user": { parameters: { @@ -104834,7 +107713,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-user": { parameters: { query?: { @@ -105014,7 +107897,7 @@ export interface operations { * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-user-installation": { parameters: { @@ -105059,9 +107942,9 @@ export interface operations { }; /** * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.11/articles/publicizing-or-concealing-organization-membership) for the specified user. + * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.13/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ "orgs/list-for-user": { parameters: { @@ -105089,7 +107972,7 @@ export interface operations { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-user": { parameters: { @@ -105126,7 +108009,7 @@ export interface operations { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-user": { parameters: { @@ -105149,9 +108032,9 @@ export interface operations { * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-user": { parameters: { @@ -105179,9 +108062,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-user": { parameters: { @@ -105209,7 +108092,7 @@ export interface operations { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { @@ -105235,7 +108118,7 @@ export interface operations { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-user": { parameters: { @@ -105259,9 +108142,9 @@ export interface operations { * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-user": { parameters: { @@ -105290,9 +108173,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.13/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-user": { parameters: { @@ -105344,7 +108227,11 @@ export interface operations { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-received-events-for-user": { parameters: { @@ -105365,7 +108252,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-received-public-events-for-user": { parameters: { query?: { @@ -105419,7 +108310,7 @@ export interface operations { }; /** * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "enterprise-admin/promote-user-to-be-site-administrator": { parameters: { @@ -105507,7 +108398,7 @@ export interface operations { * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -105565,11 +108456,11 @@ export interface operations { }; /** * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * * You can suspend any user account except your own. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." */ "enterprise-admin/suspend-user": { parameters: { @@ -105580,7 +108471,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Suspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ + /** @description The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Suspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ reason?: string; } | null; }; @@ -105594,7 +108485,7 @@ export interface operations { }; /** * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ "enterprise-admin/unsuspend-user": { parameters: { @@ -105605,7 +108496,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Unsuspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ + /** @description The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Unsuspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ reason?: string; } | null; }; @@ -105698,4 +108589,34 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-organization-fine-grained-permissions": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; } diff --git a/packages/openapi-types-ghes-3.11/LICENSE b/packages/openapi-types-ghes-3.14/LICENSE similarity index 100% rename from packages/openapi-types-ghes-3.11/LICENSE rename to packages/openapi-types-ghes-3.14/LICENSE diff --git a/packages/openapi-types-ghes-3.9/README.md b/packages/openapi-types-ghes-3.14/README.md similarity index 72% rename from packages/openapi-types-ghes-3.9/README.md rename to packages/openapi-types-ghes-3.14/README.md index 557685116..1496693c7 100644 --- a/packages/openapi-types-ghes-3.9/README.md +++ b/packages/openapi-types-ghes-3.14/README.md @@ -1,13 +1,13 @@ -# @octokit/openapi-types-ghes-3.9 +# @octokit/openapi-types-ghes-3.14 -> Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.9 +> Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.14 This package is continuously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/) ## Usage ```ts -import { components } from "@octokit/openapi-types-ghes-3.9"; +import { components } from "@octokit/openapi-types-ghes-3.14"; type Repository = components["schemas"]["full-repository"]; ``` diff --git a/packages/openapi-types-ghes-3.11/package.json b/packages/openapi-types-ghes-3.14/package.json similarity index 71% rename from packages/openapi-types-ghes-3.11/package.json rename to packages/openapi-types-ghes-3.14/package.json index 763839332..946894881 100644 --- a/packages/openapi-types-ghes-3.11/package.json +++ b/packages/openapi-types-ghes-3.14/package.json @@ -1,10 +1,10 @@ { - "name": "@octokit/openapi-types-ghes-3.11", - "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.11", + "name": "@octokit/openapi-types-ghes-3.14", + "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.14", "repository": { "type": "git", "url": "https://github.com/octokit/openapi-types.ts.git", - "directory": "packages/openapi-types-ghes-3.11" + "directory": "packages/openapi-types-ghes-3.14" }, "publishConfig": { "access": "public", @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.6.0" + "openapi-version": "17.1.0" } } diff --git a/packages/openapi-types-ghes-3.10/types.d.ts b/packages/openapi-types-ghes-3.14/types.d.ts similarity index 89% rename from packages/openapi-types-ghes-3.10/types.d.ts rename to packages/openapi-types-ghes-3.14/types.d.ts index 42aa73439..e0826e695 100644 --- a/packages/openapi-types-ghes-3.10/types.d.ts +++ b/packages/openapi-types-ghes-3.14/types.d.ts @@ -42,7 +42,7 @@ export interface paths { "/admin/hooks/{hook_id}/pings": { /** * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the webhook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) to be sent to the webhook. */ post: operations["enterprise-admin/ping-global-webhook"]; }; @@ -57,7 +57,7 @@ export interface paths { "/admin/ldap/teams/{team_id}/mapping": { /** * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. + * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ patch: operations["enterprise-admin/update-ldap-mapping-for-team"]; }; @@ -165,7 +165,7 @@ export interface paths { "/admin/users": { /** * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * @@ -176,7 +176,7 @@ export interface paths { "/admin/users/{username}": { /** * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#suspend-a-user) is often a better option. + * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#suspend-a-user) is often a better option. * * You can delete any user account except your own. */ @@ -190,19 +190,35 @@ export interface paths { /** Delete an impersonation OAuth token */ delete: operations["enterprise-admin/delete-impersonation-o-auth-token"]; }; + "/advisories": { + /** + * List global security advisories + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.14/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + */ + get: operations["security-advisories/list-global-advisories"]; + }; + "/advisories/{ghsa_id}": { + /** + * Get a global security advisory + * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + */ + get: operations["security-advisories/get-global-advisory"]; + }; "/app": { /** * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; }; "/app-manifests/{code}/conversions": { /** * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; }; @@ -211,14 +227,14 @@ export interface paths { * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; }; @@ -227,7 +243,7 @@ export interface paths { * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; }; @@ -236,7 +252,7 @@ export interface paths { * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; }; @@ -245,7 +261,7 @@ export interface paths { * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; }; @@ -270,14 +286,14 @@ export interface paths { * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; }; @@ -292,7 +308,7 @@ export interface paths { * * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; }; @@ -301,14 +317,14 @@ export interface paths { * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; }; @@ -316,9 +332,10 @@ export interface paths { /** * List your grants * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ get: operations["oauth-authorizations/list-grants"]; }; @@ -326,13 +343,15 @@ export interface paths { /** * Get a single grant * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ get: operations["oauth-authorizations/get-grant"]; /** * Delete a grant * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -341,7 +360,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; @@ -349,17 +368,17 @@ export interface paths { "/applications/{client_id}/token": { /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -371,17 +390,14 @@ export interface paths { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; }; @@ -389,23 +405,26 @@ export interface paths { /** * List your authorizations * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ get: operations["oauth-authorizations/list-authorizations"]; /** * Create a new authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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). * - * Creates 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)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * - * 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). + * 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.14/articles/creating-an-access-token-for-command-line-use). * - * 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. + * 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.14/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"]; }; @@ -413,15 +432,15 @@ export interface paths { /** * Get-or-create an authorization for a specific app * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." - * - * **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/). + * 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; }; @@ -429,13 +448,15 @@ export interface paths { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." + * 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; }; @@ -443,21 +464,24 @@ export interface paths { /** * Get a single authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ get: operations["oauth-authorizations/get-authorization"]; /** * Delete an authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ delete: operations["oauth-authorizations/delete-authorization"]; /** * Update an existing authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * 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)." + * 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * You can only send one of these scope keys at a time. */ @@ -653,7 +677,7 @@ export interface paths { * Get default workflow permissions for an enterprise * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -662,7 +686,7 @@ export interface paths { * Set default workflow permissions for an enterprise * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets * whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -908,7 +932,7 @@ export interface paths { "/enterprises/{enterprise}/code-scanning/alerts": { /** * List code scanning alerts for an enterprise - * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be a member of the enterprise to use this endpoint. * @@ -923,7 +947,7 @@ export interface paths { * * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ get: operations["secret-scanning/get-security-analysis-settings-for-enterprise"]; /** @@ -943,7 +967,7 @@ export interface paths { * * The authenticated user must be a member of the enterprise to use this endpoint. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ @@ -953,7 +977,7 @@ export interface paths { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. */ get: operations["secret-scanning/list-alerts-for-enterprise"]; }; @@ -982,7 +1006,8 @@ export interface paths { "/events": { /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; }; @@ -992,16 +1017,17 @@ export interface paths { * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -1015,7 +1041,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; }; @@ -1024,7 +1051,7 @@ export interface paths { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; }; @@ -1040,7 +1067,7 @@ export interface paths { * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1059,7 +1086,7 @@ export interface paths { * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1069,7 +1096,7 @@ export interface paths { * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1081,7 +1108,7 @@ export interface paths { * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1093,7 +1120,7 @@ export interface paths { * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1115,7 +1142,7 @@ export interface paths { get: operations["gists/check-is-starred"]; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; /** Unstar a gist */ @@ -1126,7 +1153,7 @@ export interface paths { * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1136,7 +1163,7 @@ export interface paths { "/gitignore/templates": { /** * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-for-the-authenticated-user). + * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; }; @@ -1145,7 +1172,7 @@ export interface paths { * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ @@ -1163,7 +1190,7 @@ export interface paths { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; }; @@ -1174,12 +1201,10 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -1191,33 +1216,139 @@ export interface paths { "/licenses": { /** * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; }; "/licenses/{license}": { /** * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; }; + "/manage/v1/access/ssh": { + /** + * Get the configured SSH keys + * @description Gets the configured SSH keys on all available nodes. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + get: operations["enterprise-admin/get-manage-ssh"]; + /** + * Set a new SSH key + * @description Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + post: operations["enterprise-admin/set-manage-ssh"]; + /** + * Delete a SSH key + * @description Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + delete: operations["enterprise-admin/delete-manage-ssh"]; + }; + "/manage/v1/checks/system-requirements": { + /** + * Get the system requirement check results for configured cluster nodes + * @description Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + * This endpoint may take several seconds to reply. + */ + get: operations["enterprise-admin/get-checks-system-requirements"]; + }; + "/manage/v1/cluster/status": { + /** + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. + */ + get: operations["enterprise-admin/get-cluster-status"]; + }; + "/manage/v1/config/apply": { + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + get: operations["enterprise-admin/get-manage-config-apply-status"]; + /** + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + post: operations["enterprise-admin/post-manage-run-config-apply"]; + }; + "/manage/v1/config/apply/events": { + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + get: operations["enterprise-admin/get-manage-config-apply-events"]; + }; + "/manage/v1/config/init": { + /** + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + * + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + * + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + post: operations["enterprise-admin/initialize-instance-configuration"]; + }; + "/manage/v1/config/license": { + /** + * Get the enterprise license information + * @description Gets information about the license that is currently set for the enterprise. + */ + get: operations["enterprise-admin/license-info"]; + /** + * Upload an enterprise license + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + put: operations["enterprise-admin/license-upload"]; + }; + "/manage/v1/config/license/check": { + /** + * Check a license + * @description Check the status of the license that is currently set for the enterprise. + */ + get: operations["enterprise-admin/license-check"]; + }; "/manage/v1/config/nodes": { /** * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.10/admin/enterprise-management/configuring-clustering/about-clustering)." + * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.14/admin/enterprise-management/configuring-clustering/about-clustering)." */ get: operations["enterprise-admin/get-config-nodes"]; }; + "/manage/v1/config/settings": { + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + get: operations["enterprise-admin/get-manage-settings"]; + /** + * Set settings + * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-settings). + * + * **Notes:** + * - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + * - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + */ + put: operations["enterprise-admin/set-manage-settings"]; + }; "/manage/v1/maintenance": { /** * Get the status of maintenance mode - * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ get: operations["enterprise-admin/get-manage-maintenance"]; /** * Set the status of maintenance mode - * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ post: operations["enterprise-admin/set-manage-maintenance"]; }; @@ -1232,7 +1363,7 @@ export interface paths { "/manage/v1/version": { /** * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.10/admin/all-releases)." + * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.14/admin/all-releases)." */ get: operations["enterprise-admin/get-version"]; }; @@ -1252,7 +1383,11 @@ export interface paths { get: operations["meta/get"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; }; "/notifications": { @@ -1263,7 +1398,7 @@ export interface paths { get: operations["activity/list-notifications-for-authenticated-user"]; /** * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; }; @@ -1273,6 +1408,11 @@ export interface paths { * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications. + */ + delete: operations["activity/mark-thread-as-done"]; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. @@ -1282,7 +1422,7 @@ export interface paths { "/notifications/threads/{thread_id}/subscription": { /** * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#get-a-repository-subscription). + * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ @@ -1293,12 +1433,12 @@ export interface paths { * * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; /** * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; }; @@ -1314,18 +1454,19 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; }; "/organizations/{organization_id}/custom_roles": { /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * @@ -1338,21 +1479,10 @@ export interface paths { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.14/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1366,25 +1496,18 @@ export interface paths { * * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.10/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.14/site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version. * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -1504,7 +1627,7 @@ export interface paths { * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -1513,7 +1636,7 @@ export interface paths { * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -1902,7 +2025,7 @@ export interface paths { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -1915,7 +2038,7 @@ export interface paths { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -1926,7 +2049,7 @@ export interface paths { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -2051,11 +2174,11 @@ export interface paths { "/orgs/{org}/audit-log": { /** * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -2066,7 +2189,7 @@ export interface paths { "/orgs/{org}/code-scanning/alerts": { /** * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an owner or security manager for the organization to use this endpoint. * @@ -2077,7 +2200,7 @@ export interface paths { "/orgs/{org}/custom-repository-roles": { /** * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2086,7 +2209,7 @@ export interface paths { get: operations["orgs/list-custom-repo-roles"]; /** * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2097,7 +2220,7 @@ export interface paths { "/orgs/{org}/custom-repository-roles/{role_id}": { /** * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2107,7 +2230,7 @@ export interface paths { /** * Delete a custom repository role * @description Deletes a custom role from an organization. Once the custom role has been deleted, any - * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2116,7 +2239,7 @@ export interface paths { delete: operations["orgs/delete-custom-repo-role"]; /** * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2263,7 +2386,7 @@ export interface paths { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2274,7 +2397,7 @@ export interface paths { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2283,7 +2406,7 @@ export interface paths { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2299,7 +2422,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; }; "/orgs/{org}/external-group/{group_id}": { @@ -2307,7 +2434,7 @@ export interface paths { * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; }; @@ -2316,14 +2443,16 @@ export interface paths { * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; }; "/orgs/{org}/hooks": { /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2354,7 +2483,9 @@ export interface paths { get: operations["orgs/get-webhook"]; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2436,7 +2567,7 @@ export interface paths { "/orgs/{org}/hooks/{hook_id}/pings": { /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) * to be sent to the hook. * * You must be an organization owner to use this endpoint. @@ -2451,7 +2582,7 @@ export interface paths { * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; }; @@ -2472,12 +2603,10 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -2515,13 +2644,13 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.14/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; /** @@ -2544,7 +2673,7 @@ 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)." + * 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.14/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"]; }; @@ -2577,7 +2706,7 @@ export interface paths { "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { /** * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; }; @@ -2588,6 +2717,172 @@ export interface paths { */ get: operations["migrations/list-repos-for-org"]; }; + "/orgs/{org}/organization-fine-grained-permissions": { + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + }; + "/orgs/{org}/organization-roles": { + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-org-roles"]; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific + * permissions over the organization and optionally across all repositories in the organization. For + * more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-custom-organization-role"]; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}": { + /** + * Remove all organization roles for a team + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-all-org-roles-team"]; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/assign-team-to-org-role"]; + /** + * Remove an organization role from a team + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-org-role-team"]; + }; + "/orgs/{org}/organization-roles/users/{username}": { + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-all-org-roles-user"]; + }; + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/assign-user-to-org-role"]; + /** + * Remove an organization role from a user + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-org-role-user"]; + }; + "/orgs/{org}/organization-roles/{role_id}": { + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-org-role"]; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-custom-organization-role"]; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["orgs/patch-custom-organization-role"]; + }; + "/orgs/{org}/organization-roles/{role_id}/teams": { + /** + * List teams that are assigned to an organization role + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-org-role-teams"]; + }; + "/orgs/{org}/organization-roles/{role_id}/users": { + /** + * List users that are assigned to an organization role + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-org-role-users"]; + }; "/orgs/{org}/outside_collaborators": { /** * List outside collaborators for an organization @@ -2598,7 +2893,7 @@ export interface paths { "/orgs/{org}/outside_collaborators/{username}": { /** * Convert an organization member to outside collaborator - * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.10/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.14/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; /** @@ -2612,7 +2907,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; }; @@ -2621,16 +2916,16 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; /** * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; }; @@ -2643,9 +2938,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; }; @@ -2654,7 +2949,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; }; @@ -2663,16 +2958,16 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; /** * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; }; @@ -2685,9 +2980,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; }; @@ -2792,6 +3087,71 @@ 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. + * Organization members can read these properties. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * Organization members can read these properties. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + */ + patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + }; "/orgs/{org}/public_members": { /** * List public organization members @@ -2809,7 +3169,7 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; /** @@ -2823,7 +3183,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; /** @@ -2837,7 +3198,7 @@ export interface paths { "/orgs/{org}/repository-fine-grained-permissions": { /** * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2845,6 +3206,54 @@ export interface paths { */ get: operations["orgs/list-repo-fine-grained-permissions"]; }; + "/orgs/{org}/rulesets": { + /** + * Get all organization repository rulesets + * @description Get all the repository rulesets for an organization. + */ + get: operations["repos/get-org-rulesets"]; + /** + * Create an organization repository ruleset + * @description Create a repository ruleset for an organization. + */ + 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-server@3.14/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-server@3.14/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 + * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + get: operations["repos/get-org-ruleset"]; + /** + * Update an organization repository ruleset + * @description Update a ruleset for an organization. + */ + put: operations["repos/update-org-ruleset"]; + /** + * Delete an organization repository ruleset + * @description Delete a ruleset for an organization. + */ + delete: operations["repos/delete-org-ruleset"]; + }; "/orgs/{org}/secret-scanning/alerts": { /** * List secret scanning alerts for an organization @@ -2859,7 +3268,7 @@ export interface paths { "/orgs/{org}/security-managers": { /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * @@ -2870,7 +3279,7 @@ export interface paths { "/orgs/{org}/security-managers/teams/{team_slug}": { /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2879,7 +3288,7 @@ export interface paths { put: operations["orgs/add-security-manager-team"]; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2908,9 +3317,9 @@ export interface paths { get: operations["teams/list"]; /** * Create a team - * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.10/articles/setting-team-creation-permissions-in-your-organization)." + * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.14/articles/setting-team-creation-permissions-in-your-organization)." * - * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; }; @@ -2919,7 +3328,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; /** @@ -2928,14 +3338,16 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; }; @@ -2944,7 +3356,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2953,9 +3366,10 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2966,7 +3380,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2975,7 +3390,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2984,7 +3400,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2995,7 +3412,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3004,9 +3422,10 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3017,7 +3436,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -3026,7 +3446,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3035,7 +3456,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3044,20 +3466,22 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3066,9 +3490,10 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3077,20 +3502,22 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3099,9 +3526,10 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3112,21 +3540,21 @@ export interface paths { * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; }; @@ -3146,38 +3574,43 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; /** * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; }; @@ -3186,7 +3619,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; }; @@ -3195,21 +3629,24 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; }; @@ -3218,7 +3655,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; }; @@ -3227,29 +3665,32 @@ export interface paths { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * - * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; }; @@ -3258,18 +3699,23 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; }; "/orgs/{org}/{security_product}/{enablement}": { /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -3376,20 +3822,22 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.10/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.10/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.10/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.10/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.14/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.14/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.14/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.14/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.14/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.14/rest/about-the-rest-api/api-versions)." + * + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; }; @@ -3398,7 +3846,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; /** @@ -3413,7 +3862,7 @@ export interface paths { delete: operations["repos/delete"]; /** * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#replace-all-repository-topics) endpoint. + * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; }; @@ -3602,8 +4051,8 @@ export interface paths { * Get the level of access for workflows outside of the repository * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3612,8 +4061,8 @@ export interface paths { * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3644,7 +4093,7 @@ export interface paths { * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3653,7 +4102,7 @@ export interface paths { * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3804,13 +4253,13 @@ export interface paths { "/repos/{owner}/{repo}/actions/runs": { /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; }; @@ -3869,7 +4318,7 @@ export interface paths { /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -3901,20 +4350,30 @@ export interface paths { "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { /** * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ 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). + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope 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 * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -4016,7 +4475,7 @@ export interface paths { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -4137,18 +4596,30 @@ export interface paths { "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; }; + "/repos/{owner}/{repo}/activity": { + /** + * 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. + * + * For more information about viewing repository activity, + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.14/repositories/viewing-activity-and-data-for-your-repository)." + */ + get: operations["repos/list-activities"]; + }; "/repos/{owner}/{repo}/assignees": { /** * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.10/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.14/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; }; @@ -4196,7 +4667,7 @@ export interface paths { "/repos/{owner}/{repo}/automated-security-fixes": { /** * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.10/articles/configuring-automated-security-fixes)". + * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.14/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; }; @@ -4211,42 +4682,44 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection": { /** * Get branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-branch-protection"]; /** * Update branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; /** * Delete branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { /** * Get admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; /** * Set admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -4255,44 +4728,46 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { /** * Get pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; /** * Delete pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; /** * Update pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { /** * Get commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.10/articles/signing-commits-with-gpg) in GitHub Help. + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.14/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; /** * Create commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -4301,17 +4776,17 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { /** * Get status checks protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; /** * Remove status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; /** * Update status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -4320,38 +4795,39 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { /** * Get all status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-all-status-check-contexts"]; /** * Set status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ put: operations["repos/set-status-check-contexts"]; /** * Add status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ post: operations["repos/add-status-check-contexts"]; /** * Remove status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { /** * Get access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; /** * Delete access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -4360,28 +4836,28 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { /** * Get apps with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -4390,28 +4866,28 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { /** * Get teams with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ @@ -4420,14 +4896,14 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { /** * Get users with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -4438,7 +4914,7 @@ export interface paths { put: operations["repos/set-user-access-restrictions"]; /** * Add user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -4449,7 +4925,7 @@ export interface paths { post: operations["repos/add-user-access-restrictions"]; /** * Remove user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -4464,7 +4940,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -4488,7 +4965,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4497,7 +4975,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4515,9 +4994,9 @@ export interface paths { "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4526,9 +5005,10 @@ export interface paths { "/repos/{owner}/{repo}/check-suites": { /** * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites)". + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.14/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4537,7 +5017,7 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/preferences": { /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#create-a-check-suite). + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; @@ -4547,7 +5027,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4558,7 +5039,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4567,7 +5049,7 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { /** * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4624,8 +5106,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -4646,7 +5128,7 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * @@ -4741,7 +5223,7 @@ export interface paths { "/repos/{owner}/{repo}/code-scanning/sarifs": { /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -4754,7 +5236,7 @@ export interface paths { * ``` * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -4773,6 +5255,8 @@ export interface paths { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -4791,7 +5275,7 @@ export interface paths { * file. * * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * see "[About code owners](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; }; @@ -4823,17 +5307,17 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Updating an existing collaborator's permission level** * @@ -4858,11 +5342,12 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; }; @@ -4884,7 +5369,7 @@ export interface paths { * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4898,7 +5383,7 @@ export interface paths { * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4912,7 +5397,7 @@ export interface paths { * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4924,21 +5409,22 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). + * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; }; @@ -4955,6 +5441,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -4979,7 +5466,7 @@ export interface paths { "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { /** * List branches for HEAD commit - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -4990,7 +5477,7 @@ export interface paths { * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5002,9 +5489,9 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5027,9 +5514,10 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -5045,6 +5533,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5071,9 +5560,10 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. + * 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.14/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.14/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5084,7 +5574,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5116,11 +5607,11 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.14/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.diff`**: Returns the diff of the commit. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -5133,10 +5624,10 @@ export interface paths { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api)." * * **Signature verification object** * @@ -5148,6 +5639,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5174,7 +5666,7 @@ export interface paths { * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -5188,9 +5680,9 @@ export interface paths { * * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree). * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree). * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. * - If the requested file's size is: * - 1 MB or smaller: All features of this endpoint are supported. @@ -5203,7 +5695,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.14/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -5218,7 +5711,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.14/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -5246,7 +5740,7 @@ export interface paths { get: operations["dependabot/get-alert"]; /** * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -5284,7 +5778,7 @@ export interface paths { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5344,7 +5838,7 @@ export interface paths { * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) for every submitted context must be in a `success` + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.14/rest/commits/statuses) for every submitted context must be in a `success` * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do * not require any contexts or create any commit statuses, the deployment will always succeed. @@ -5393,7 +5887,7 @@ export interface paths { * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * * Mark the active deployment as inactive by adding any non-successful deployment status. * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ @@ -5423,7 +5917,7 @@ export interface paths { "/repos/{owner}/{repo}/dispatches": { /** * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#repository_dispatch)." + * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#repository_dispatch)." * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * @@ -5447,7 +5941,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -5458,9 +5953,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5483,7 +5980,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5492,7 +5989,7 @@ 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. * @@ -5501,14 +5998,14 @@ export interface paths { 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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope 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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5517,9 +6014,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -5530,7 +6027,7 @@ export interface paths { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5539,11 +6036,13 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app)". * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -5552,9 +6051,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -5606,7 +6105,7 @@ export interface paths { /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -5675,7 +6174,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; }; @@ -5686,9 +6186,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; }; @@ -5701,7 +6203,7 @@ export interface paths { * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw blob data. * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -5725,6 +6227,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5763,6 +6266,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5791,7 +6295,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -5802,7 +6307,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; }; @@ -5828,7 +6334,7 @@ export interface paths { "/repos/{owner}/{repo}/git/tags": { /** * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * * **Signature verification object** * @@ -5840,6 +6346,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5874,6 +6381,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5900,7 +6408,7 @@ export interface paths { * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.10/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.10/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference)." * * Returns an error if you try to delete a file that does not exist. */ @@ -5913,8 +6421,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; }; @@ -5937,7 +6445,12 @@ export interface paths { * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -5985,7 +6498,7 @@ export interface paths { "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { /** * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; }; @@ -5994,7 +6507,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; }; @@ -6003,7 +6517,7 @@ export interface paths { * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; }; @@ -6025,12 +6539,10 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6040,12 +6552,12 @@ export interface paths { get: operations["issues/list-for-repo"]; /** * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.10/articles/disabling-issues/), the API returns a `410 Gone` status. + * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.14/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6061,7 +6573,7 @@ export interface paths { * * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6075,7 +6587,7 @@ export interface paths { * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6092,7 +6604,7 @@ export interface paths { * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6104,21 +6616,22 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). + * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; }; @@ -6139,19 +6652,17 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}": { /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.10/articles/transferring-an-issue-to-another-repository/) to another repository. If + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + * [transferred](https://docs.github.com/enterprise-server@3.14/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - * to the [`issues`](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#issues) webhook. + * to the [`issues`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6161,9 +6672,9 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6202,7 +6713,7 @@ export interface paths { * * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6214,12 +6725,12 @@ export interface paths { * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6269,7 +6780,7 @@ export interface paths { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; /** @@ -6281,21 +6792,22 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). + * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; }; @@ -6381,7 +6893,7 @@ export interface paths { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -6440,7 +6952,7 @@ export interface paths { get: operations["activity/list-repo-notifications-for-authenticated-user"]; /** * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; }; @@ -6523,6 +7035,24 @@ export interface paths { */ post: operations["repos/create-pages-deployment"]; }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + get: operations["repos/get-pages-deployment"]; + }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + post: operations["repos/cancel-pages-deployment"]; + }; "/repos/{owner}/{repo}/pre-receive-hooks": { /** * List pre-receive hooks for a repository @@ -6558,6 +7088,22 @@ 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 read access to the repository can use this endpoint. + */ + get: operations["repos/get-custom-properties-values"]; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + patch: operations["repos/create-or-update-custom-properties-values"]; + }; "/repos/{owner}/{repo}/pulls": { /** * List pull requests @@ -6566,10 +7112,10 @@ export interface paths { * 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-server@3.10/github/getting-started-with-github/githubs-products) + * Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6579,13 +7125,13 @@ export interface paths { get: operations["pulls/list"]; /** * Create a pull request - * @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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6600,7 +7146,7 @@ export interface paths { * @description Lists review comments for all pull requests in a repository. By default, * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6614,7 +7160,7 @@ export interface paths { * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6631,7 +7177,7 @@ export interface paths { * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6643,44 +7189,45 @@ 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/rest/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.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** * Create reaction for a pull request review comment - * @description Create a reaction 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). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction 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). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { /** * Get a pull request - * @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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6691,11 +7238,11 @@ export interface paths { get: operations["pulls/get"]; /** * Update a pull request - * @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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6710,7 +7257,7 @@ export interface paths { * @description Lists all review comments for a specified pull request. By default, review comments * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6720,16 +7267,16 @@ export interface paths { get: operations["pulls/list-review-comments"]; /** * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#create-an-issue-comment)." + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment)." * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6743,10 +7290,10 @@ export interface paths { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6759,10 +7306,10 @@ export interface paths { /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits) + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits) * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6776,10 +7323,10 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6797,14 +7344,14 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { /** * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** @@ -6823,7 +7370,7 @@ export interface paths { * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6835,15 +7382,16 @@ export interface paths { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6857,7 +7405,7 @@ export interface paths { * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6869,7 +7417,7 @@ export interface paths { * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6881,7 +7429,7 @@ export interface paths { * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6895,7 +7443,7 @@ export interface paths { * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6909,11 +7457,10 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6925,9 +7472,9 @@ export interface paths { "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6940,6 +7487,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -6948,7 +7496,7 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -6960,7 +7508,7 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -6970,7 +7518,7 @@ export interface paths { "/repos/{owner}/{repo}/releases": { /** * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-tags). + * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ @@ -6979,14 +7527,20 @@ export interface paths { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; /** Delete a release asset */ @@ -7000,7 +7554,7 @@ export interface paths { "/repos/{owner}/{repo}/releases/generate-notes": { /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; }; @@ -7025,9 +7579,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; /** @@ -7046,8 +7599,8 @@ export interface paths { get: operations["repos/list-release-assets"]; /** * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release) to upload a release asset. + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * @@ -7061,9 +7614,9 @@ export interface paths { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets)" + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; @@ -7071,21 +7624,22 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions": { /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). + * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; }; @@ -7096,6 +7650,64 @@ export interface paths { */ get: operations["repos/list-cache-info"]; }; + "/repos/{owner}/{repo}/rules/branches/{branch}": { + /** + * Get rules for a branch + * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. + */ + get: operations["repos/get-branch-rules"]; + }; + "/repos/{owner}/{repo}/rulesets": { + /** + * Get all repository rulesets + * @description Get all the rulesets for a repository. + */ + get: operations["repos/get-repo-rulesets"]; + /** + * Create a repository ruleset + * @description Create a ruleset for a repository. + */ + 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-server@3.14/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-server@3.14/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 + * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + get: operations["repos/get-repo-ruleset"]; + /** + * Update a repository ruleset + * @description Update a ruleset for a repository. + */ + put: operations["repos/update-repo-ruleset"]; + /** + * Delete a repository ruleset + * @description Delete a ruleset for a repository. + */ + delete: operations["repos/delete-repo-ruleset"]; + }; "/repos/{owner}/{repo}/secret-scanning/alerts": { /** * List secret scanning alerts for a repository @@ -7143,7 +7755,7 @@ export interface paths { * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -7224,12 +7836,12 @@ export interface paths { get: operations["activity/get-repo-subscription"]; /** * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#delete-a-repository-subscription) completely. + * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; /** * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#set-a-repository-subscription). + * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; }; @@ -7239,23 +7851,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -7266,7 +7890,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -7290,26 +7916,26 @@ export interface paths { "/repos/{owner}/{repo}/transfer": { /** * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.10/articles/about-repository-transfers/). + * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.14/articles/about-repository-transfers/). */ post: operations["repos/transfer"]; }; "/repos/{owner}/{repo}/vulnerability-alerts": { /** * Check if vulnerability alerts are enabled for a repository - * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". */ get: operations["repos/check-vulnerability-alerts"]; /** * Enable vulnerability alerts - * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". */ put: operations["repos/enable-vulnerability-alerts"]; /** * Disable vulnerability alerts * @description Disables dependency alerts for a repository. * The authenticated user must have admin access to the repository. For more information, - * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". */ delete: operations["repos/disable-vulnerability-alerts"]; }; @@ -7320,14 +7946,15 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; }; "/repos/{template_owner}/{template_repo}/generate": { /** * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ @@ -7340,14 +7967,15 @@ export interface paths { * * Note: * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; }; "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -7356,7 +7984,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -7367,14 +7996,16 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -7383,14 +8014,16 @@ export interface paths { put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -7403,7 +8036,8 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -7412,7 +8046,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -7425,59 +8060,66 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; }; "/search/code": { /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -7499,10 +8141,10 @@ export interface paths { "/search/commits": { /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -7513,10 +8155,10 @@ export interface paths { "/search/issues": { /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -7524,16 +8166,17 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.14/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; }; "/search/labels": { /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -7546,9 +8189,9 @@ export interface paths { "/search/repositories": { /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -7561,9 +8204,9 @@ export interface paths { "/search/topics": { /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.10/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.14/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -7576,9 +8219,9 @@ export interface paths { "/search/users": { /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -7586,7 +8229,7 @@ export interface paths { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.14/graphql/reference/queries#search)." */ get: operations["search/users"]; }; @@ -7623,26 +8266,28 @@ export interface paths { get: operations["enterprise-admin/get-maintenance-status"]; /** * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * @description > [!NOTE] + * > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; }; "/setup/api/settings": { /** * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#set-settings). + * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * > [!NOTE] + * > You cannot retrieve the management console password with the Enterprise administration API. */ get: operations["enterprise-admin/get-settings"]; /** * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings). + * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings). * * **Notes:** * * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." */ put: operations["enterprise-admin/set-settings"]; }; @@ -7665,14 +8310,15 @@ export interface paths { * Create a GitHub license * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/create-enterprise-server-license"]; }; @@ -7681,7 +8327,8 @@ export interface paths { * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/upgrade-license"]; }; @@ -7689,13 +8336,15 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -7705,11 +8354,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -7717,7 +8368,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -7727,11 +8379,12 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7741,7 +8394,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -7751,7 +8405,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -7761,7 +8416,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -7773,7 +8429,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -7783,11 +8440,12 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7797,7 +8455,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -7807,7 +8466,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -7817,7 +8477,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -7829,9 +8490,10 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -7839,9 +8501,10 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * @@ -7853,9 +8516,10 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -7863,9 +8527,10 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * @@ -7877,7 +8542,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.10/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -7887,9 +8553,9 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. */ @@ -7897,31 +8563,33 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; }; @@ -7929,7 +8597,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -7938,19 +8607,21 @@ export interface paths { * **Note:** * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -7960,13 +8631,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; }; @@ -7974,7 +8647,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -7984,7 +8658,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -7992,7 +8667,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -8000,7 +8676,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -8010,7 +8687,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; }; @@ -8018,27 +8696,31 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -8048,7 +8730,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; }; @@ -8112,7 +8795,7 @@ export interface paths { get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ @@ -8181,11 +8864,15 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -8194,12 +8881,10 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -8311,6 +8996,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -8319,7 +9007,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; }; @@ -8328,14 +9016,14 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; /** * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; }; @@ -8348,7 +9036,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; }; @@ -8357,7 +9045,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; }; @@ -8366,7 +9054,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; /** @@ -8375,7 +9063,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; }; @@ -8388,7 +9076,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; }; @@ -8403,7 +9091,7 @@ export interface paths { /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) * endpoint. * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -8497,7 +9185,7 @@ export interface paths { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -8511,7 +9199,7 @@ export interface paths { get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; /** @@ -8539,12 +9227,23 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.14/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; }; @@ -8553,9 +9252,9 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.10/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.14/rest/users/emails)". */ get: operations["users/get-by-username"]; }; @@ -8571,7 +9270,10 @@ export interface paths { "/users/{username}/events": { /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; }; @@ -8579,11 +9281,18 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; }; "/users/{username}/followers": { @@ -8634,7 +9343,7 @@ export interface paths { * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; }; @@ -8648,9 +9357,9 @@ export interface paths { "/users/{username}/orgs": { /** * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.10/articles/publicizing-or-concealing-organization-membership) for the specified user. + * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.14/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; }; @@ -8659,7 +9368,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; }; @@ -8668,16 +9377,16 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; /** * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; }; @@ -8690,9 +9399,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; }; @@ -8701,7 +9410,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; }; @@ -8710,16 +9419,16 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; /** * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; }; @@ -8732,9 +9441,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; }; @@ -8748,12 +9457,20 @@ export interface paths { "/users/{username}/received_events": { /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -8766,7 +9483,7 @@ export interface paths { "/users/{username}/site_admin": { /** * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/promote-user-to-be-site-administrator"]; /** @@ -8794,7 +9511,7 @@ export interface paths { * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -8810,16 +9527,16 @@ export interface paths { "/users/{username}/suspended": { /** * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * * You can suspend any user account except your own. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/suspend-user"]; /** * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ delete: operations["enterprise-admin/unsuspend-user"]; }; @@ -8987,9 +9704,11 @@ export interface components { ping_url?: string; }; "public-key-full": { + /** Format: int64 */ id: number; key: string; user_id: number | null; + /** Format: int64 */ repository_id: number | null; url: string; title: string; @@ -9025,7 +9744,10 @@ export interface components { ldap_dn?: string; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9139,6 +9861,8 @@ export interface components { /** Format: date-time */ suspended_at?: string | null; business_plus?: boolean; + /** @example public */ + user_view_type?: string; }; /** * Organization Simple @@ -9180,6 +9904,7 @@ export interface components { description: string | null; }; "pre-receive-environment": { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9213,6 +9938,7 @@ export interface components { html_url?: string; }; environment?: { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9239,7 +9965,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9298,6 +10027,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * App Permissions @@ -9375,6 +10106,11 @@ export interface components { * @enum {string} */ pull_requests?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + * @enum {string} + */ + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} @@ -9436,7 +10172,17 @@ export interface components { */ organization_custom_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for custom organization roles management. + * @enum {string} + */ + organization_custom_org_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom property management. + * @enum {string} + */ + organization_custom_properties?: "read" | "write" | "admin"; + /** + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -9471,7 +10217,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -9545,7 +10291,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9604,6 +10353,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** Scoped Installation */ "nullable-scoped-installation": { @@ -9636,6 +10387,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -9663,6 +10415,191 @@ export interface components { /** Format: date-time */ expires_at: string | null; }; + /** + * @description The package's language or package management ecosystem. + * @enum {string} + */ + "security-advisory-ecosystems": + | "rubygems" + | "npm" + | "pip" + | "maven" + | "nuget" + | "composer" + | "go" + | "rust" + | "erlang" + | "actions" + | "pub" + | "other" + | "swift"; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + vulnerable_functions: readonly string[] | null; + }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; + /** + * @description The type of credit the user is receiving. + * @enum {string} + */ + "security-advisory-credit-types": + | "analyst" + | "finder" + | "reporter" + | "coordinator" + | "remediation_developer" + | "remediation_reviewer" + | "remediation_verifier" + | "tool" + | "sponsor" + | "other"; + /** @description A GitHub Security Advisory. */ + "global-advisory": { + /** @description The GitHub Security Advisory ID. */ + ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + cve_id: string | null; + /** @description The API URL for the advisory. */ + url: string; + /** + * Format: uri + * @description The URL for the advisory. + */ + html_url: string; + /** + * Format: uri + * @description The API URL for the repository advisory. + */ + repository_advisory_url: string | null; + /** @description A short summary of the advisory. */ + summary: string; + /** @description A detailed description of what the advisory entails. */ + description: string | null; + /** + * @description The type of advisory. + * @enum {string} + */ + type: "reviewed" | "unreviewed" | "malware"; + /** + * @description The severity of the advisory. + * @enum {string} + */ + severity: "critical" | "high" | "medium" | "low" | "unknown"; + /** + * Format: uri + * @description The URL of the advisory's source code. + */ + source_code_location: string | null; + identifiers: + | readonly { + /** + * @description The type of identifier. + * @enum {string} + */ + type: "CVE" | "GHSA"; + /** @description The identifier value. */ + value: string; + }[] + | null; + references: string[] | null; + /** + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. + */ + published_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. + */ + updated_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + */ + github_reviewed_at: string | null; + /** + * Format: date-time + * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. + */ + nvd_published_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + withdrawn_at: string | null; + /** @description The products and respective version ranges affected by the advisory. */ + vulnerabilities: components["schemas"]["vulnerability"][] | null; + cvss: { + /** @description The CVSS vector. */ + vector_string: string | null; + /** @description The CVSS score. */ + score: number | null; + } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; + cwes: + | { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + cwe_id: string; + /** @description The name of the CWE. */ + name: string; + }[] + | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; + /** @description In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available. */ + credits: + | readonly { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; + }[] + | null; + }; + /** + * Basic Error + * @description Basic Error + */ + "basic-error": { + message?: string; + documentation_url?: string; + url?: string; + status?: string; + }; + /** + * Validation Error Simple + * @description Validation Error Simple + */ + "validation-error-simple": { + message: string; + documentation_url: string; + errors?: string[]; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -9736,8 +10673,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -9745,25 +10680,6 @@ export interface components { /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; } | null; - /** - * Basic Error - * @description Basic Error - */ - "basic-error": { - message?: string; - documentation_url?: string; - url?: string; - status?: string; - }; - /** - * Validation Error Simple - * @description Validation Error Simple - */ - "validation-error-simple": { - message: string; - documentation_url: string; - errors?: string[]; - }; /** * Format: uri * @description The URL to which the payloads will be delivered. @@ -9776,7 +10692,7 @@ export interface components { */ "webhook-config-content-type": string; /** - * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers). + * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers). * @example "********" */ "webhook-config-secret": string; @@ -9852,6 +10768,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -9942,6 +10864,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -10129,6 +11057,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -10420,7 +11349,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10507,7 +11436,10 @@ export interface components { * @description The authorization associated with an OAuth Access. */ "application-grant": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * Format: uri @@ -10604,7 +11536,7 @@ export interface components { html_url: string | null; }; /** - * @description The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.10/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + * @description The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.14/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." * @example Very **important** announcement about _something_. */ "announcement-message": string | null; @@ -11005,9 +11937,9 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -11023,10 +11955,10 @@ export interface components { * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -11034,8 +11966,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -11048,6 +11978,8 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -11109,6 +12041,7 @@ export interface components { */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -11370,6 +12303,11 @@ export interface components { * @example false */ advanced_security_enabled_for_new_repositories: boolean; + /** + * @description Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. + * @example false + */ + advanced_security_enabled_for_new_user_namespace_repositories?: boolean; /** * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this * enterprise. @@ -11441,6 +12379,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -11574,7 +12513,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -11590,11 +12529,18 @@ export interface components { push_protection_bypassed_at?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; "advanced-security-active-committers-user": { user_login: string; /** @example 2021-11-03 */ last_pushed_date: string; + /** @example monalisa@github.com */ + last_pushed_email: string; }; "advanced-security-active-committers-repository": { /** @example octocat/Hello-World */ @@ -11608,6 +12554,16 @@ export interface components { total_advanced_security_committers?: number; /** @example 2 */ total_count?: number; + /** + * @description The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security + * @example 4 + */ + maximum_advanced_security_committers?: number; + /** + * @description The total number of GitHub Advanced Security licences purchased + * @example 4 + */ + purchased_advanced_security_committers?: number; repositories: components["schemas"]["advanced-security-active-committers-repository"][]; }; /** @@ -11766,8 +12722,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -11804,6 +12758,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -11911,6 +12871,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -12070,6 +13031,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -12093,7 +13059,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -12124,6 +13092,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -12141,8 +13111,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -12251,6 +13219,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -12446,6 +13419,158 @@ export interface components { /** @example true */ featured: boolean; }; + "ghes-get-ssh": { + /** + * Format: ssh-key + * @description The full public key + */ + key?: string; + /** + * Format: ssh-key fingerprint + * @description The fingerprint of the key + */ + fingerprint?: string; + }[]; + /** Set SSH key */ + "ghes-set-ssh-request": { + /** @description The public SSH key to add to the `authorized_keys` file. */ + key: string; + }; + "ghes-set-ssh-response": { + /** + * Format: hostname + * @description Hostname of the node where the SSH key was added. + */ + hostname?: string; + /** + * Format: uuid + * @description UUID of the SSH key that was added. + */ + uuid?: string; + /** @description Message indicating the result of the SSH key addition. */ + message?: string; + /** @description Error message indicating the reason for the SSH key addition failure. This field is only present if the SSH key addition failed. */ + error?: string; + /** @description Whether the SSH key was already present on the `authorized_keys` file. */ + modified?: boolean; + }[]; + /** Set SSH key */ + "ghes-delete-ssh-request": { + /** @description The public SSH key to remove from the `authorized_keys` file. */ + key: string; + }; + "ghes-delete-ssh-response": { + /** + * Format: hostname + * @description Hostname of the node where the SSH key was removed. + */ + hostname?: string; + /** + * Format: uuid + * @description UUID of the SSH key that was removed. + */ + uuid?: string; + /** @description Message indicating the result of the SSH key removal. */ + message?: string; + /** @description Error message indicating the reason for the SSH key removal failure. This field is only present if the SSH key removal failed. */ + error?: string; + }[]; + /** @enum {string} */ + "ghes-checks-result-indicator": "OK" | "FAILED"; + "ghes-checks-system-requirements": { + status?: components["schemas"]["ghes-checks-result-indicator"]; + nodes?: { + hostname?: string; + status?: components["schemas"]["ghes-checks-result-indicator"]; + roles_status?: { + status?: components["schemas"]["ghes-checks-result-indicator"]; + role?: string; + }[]; + }[]; + }; + /** @enum {string} */ + "ghes-cluster-status-indicator": "UNKNOWN" | "OK" | "WARNING" | "CRITICAL"; + "ghes-cluster-status": { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + nodes?: { + hostname?: string; + status?: components["schemas"]["ghes-cluster-status-indicator"]; + services?: { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + name?: string; + details?: string; + }[]; + }[]; + }; + /** Initialize configuration with license upload */ + "ghes-config-init-request": { + /** @description The content of your _.ghl_ license file. */ + license: string; + /** @description The root site administrator password. */ + password: string; + }; + "ghes-license-info": { + /** @description Whether the GitHub Advanced Security feature is enabled. */ + advancedSecurityEnabled?: boolean; + /** @description If the GitHub Advanced Security feature is enabled, the seat count. */ + advancedSecuritySeats?: number; + /** @description Whether the cluster support feature is enabled. */ + clusterSupport?: boolean; + /** @description The company under which the license is issued. */ + company?: string; + /** @description Whether the Github Connect feature is enabled. */ + croquetSupport?: boolean; + /** @description Whether this license is issued under custom terms. */ + customTerms?: boolean; + /** @description Wheter this license is issued as an evaluation license. */ + evaluation?: boolean; + /** + * Format: date-time + * @description The expiration date of the license. + * @example 2025-01-02T07:59:59Z + */ + expireAt?: string; + /** @description Whether the insights feature is enabled. */ + insightsEnabled?: boolean; + /** + * Format: date-time + * @description If the insights feature is enabled, the expiration date. + * @example 2025-01-02T07:59:59Z + */ + insightsExpireAt?: string; + /** + * Format: date-time + * @description If the learning lab feature is enabled, the expiration date. + * @example 2025-01-02T07:59:59Z + */ + learningLabEvaluationExpires?: string; + /** @description If the learning lab feature is enabled, the seat count. */ + learningLabSeats?: number; + /** @description Whether the perpetual feature is enabled. */ + perpetual?: boolean; + /** @description The unique reference number of the license. */ + referenceNumber?: string; + /** @description If the license is issued with limited seating, the seat count. */ + seats?: number; + /** @description Whether the SSH feature is enabled. */ + sshAllowed?: boolean; + /** @description The support key of the license. */ + supportKey?: string; + /** @description Whether the license is issued with unlimited seat count. */ + unlimitedSeating?: boolean; + }; + /** License upload form */ + "ghes-upload-license-request": { + /** @description The content of your _.ghl_ license file. */ + license: string; + }; + "ghes-license-check": { + /** + * @description The license status of the currently active enterprise license. + * @enum {string} + */ + status?: "valid" | "invalid" | "expired" | "cluster mode not supported"; + }; /** @enum {string} */ "ghes-cluster-topology": "SingleNode" | "Ha" | "Cluster"; /** @enum {string} */ @@ -12474,6 +13599,141 @@ export interface components { cluster_roles?: components["schemas"]["ghes-cluster-roles"][]; }[]; }; + "ghes-get-settings": { + private_mode?: boolean; + public_pages?: boolean; + subdomain_isolation?: boolean; + signup_enabled?: boolean; + github_hostname?: string; + identicons_host?: string; + http_proxy?: string | null; + auth_mode?: string; + expire_sessions?: boolean; + admin_password?: string | null; + configuration_id?: number; + configuration_run_count?: number; + avatar?: { + enabled?: boolean; + uri?: string; + }; + customer?: { + name?: string; + email?: string; + uuid?: string; + secret_key_data?: string; + public_key_data?: string; + }; + license?: { + seats?: number; + evaluation?: boolean; + perpetual?: boolean; + unlimited_seating?: boolean; + support_key?: string; + ssh_allowed?: boolean; + cluster_support?: boolean; + expire_at?: string; + }; + github_ssl?: { + enabled?: boolean; + cert?: string | null; + key?: string | null; + }; + ldap?: { + host?: string | null; + port?: number; + base?: string[]; + uid?: string | null; + bind_dn?: string | null; + password?: string | null; + method?: string; + search_strategy?: string; + user_groups?: string[]; + admin_group?: string | null; + virtual_attribute_enabled?: boolean; + recursive_group_search?: boolean; + posix_support?: boolean; + user_sync_emails?: boolean; + user_sync_keys?: boolean; + user_sync_interval?: number; + team_sync_interval?: number; + sync_enabled?: boolean; + reconciliation?: { + user?: string | null; + org?: string | null; + }; + profile?: { + uid?: string; + name?: string | null; + mail?: string | null; + key?: string | null; + }; + }; + cas?: { + url?: string | null; + }; + saml?: { + sso_url?: string | null; + certificate?: string | null; + certificate_path?: string | null; + issuer?: string | null; + idp_initiated_sso?: boolean; + disable_admin_demote?: boolean; + }; + github_oauth?: { + client_id?: string; + client_secret?: string; + organization_name?: string; + organization_team?: string; + }; + smtp?: { + enabled?: boolean; + address?: string; + authentication?: string; + port?: string; + domain?: string; + username?: string; + user_name?: string; + enable_starttls_auto?: boolean; + password?: string; + "discard-to-noreply-address"?: boolean; + support_address?: string; + support_address_type?: string; + noreply_address?: string; + }; + ntp?: { + primary_server?: string; + secondary_server?: string; + }; + timezone?: string | null; + snmp?: { + enabled?: boolean; + community?: string; + }; + syslog?: { + enabled?: boolean; + server?: string | null; + protocol_name?: string; + }; + assets?: string | null; + pages?: { + enabled?: boolean; + }; + collectd?: { + enabled?: boolean; + server?: string | null; + port?: number; + encryption?: string | null; + username?: string | null; + password?: string | null; + }; + mapping?: { + enabled?: boolean; + tileserver?: string | null; + basemap?: string; + token?: string | null; + }; + load_balancer?: string | null; + }; "ghes-get-maintenance": { /** Format: hostname */ hostname?: string; @@ -12565,20 +13825,27 @@ export interface components { * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ - dependabot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; - /** @example 3.10.0 */ + /** @example 3.14.0 */ installed_version?: string; }; "security-and-analysis": { @@ -12608,7 +13875,10 @@ export interface components { * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -12974,7 +14244,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -13012,47 +14287,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -13075,6 +14363,8 @@ export interface components { created_at: string; /** Format: date-time */ updated_at: string; + /** Format: date-time */ + archived_at: string | null; }; /** * Actions Cache Usage by repository @@ -13332,7 +14622,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -13801,7 +15094,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -13839,6 +15135,311 @@ export interface components { /** @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"`. */ exclude?: string[]; }; + /** + * Organization Fine-Grained Permission + * @description A fine-grained permission that protects organization resources. + */ + "organization-fine-grained-permission": { + name: string; + description: string; + }; + /** + * Organization Role + * @description Organization roles + */ + "organization-role": { + /** + * Format: int64 + * @description The unique identifier of the role. + */ + id: number; + /** @description The name of the role. */ + name: string; + /** @description A short description about who this role is for or what permissions it grants. */ + description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; + /** @description A list of permissions included in this role. */ + permissions: string[]; + organization: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The date and time the role was created. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the role was last updated. + */ + updated_at: string; + }; + "organization-custom-organization-role-create-schema": { + /** @description The name of the custom role. */ + name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions: string[]; + }; + "organization-custom-organization-role-update-schema": { + /** @description The name of the custom role. */ + name?: string; + /** @description A short description about the intended use of this role or the permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions?: string[]; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + } | null; + /** + * A Role Assignment for a Team + * @description The Relationship a Team has with a role. + */ + "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + }; + /** + * A Role Assignment for a User + * @description The Relationship a User has with a role. + */ + "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** @example 1 */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + }; /** * Package Version * @description A version of a software package @@ -13932,6 +15533,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -13944,7 +15549,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -13968,6 +15573,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14047,12 +15656,102 @@ 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 + */ + "custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + 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 | 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"][]; + }; /** * Repository * @description A repository on GitHub. */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -14344,7 +16043,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -14428,7 +16127,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14728,6 +16430,10 @@ export interface components { anonymous_access_enabled?: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Repository Fine-Grained Permission @@ -14738,131 +16444,575 @@ export interface components { description: string; }; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * @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 not available for the `repository` target. + * @enum {string} */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + /** + * Repository Ruleset Bypass Actor + * @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. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + actor_id?: number | null; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The type of actor that can bypass a ruleset + * @enum {string} */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + actor_type: + | "Integration" + | "OrganizationAdmin" + | "RepositoryRole" + | "Team" + | "DeployKey"; /** - * @description Name of the team - * @example Justice League + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always + * @enum {string} */ + bypass_mode?: "always" | "pull_request"; + }; + /** + * Repository ruleset conditions for ref names + * @description Parameters for a repository ruleset ref name condition + */ + "repository-ruleset-conditions": { + ref_name?: { + /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ + include?: string[]; + /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + }; + }; + /** + * Repository ruleset conditions for repository names + * @description Parameters for a repository name condition + */ + "repository-ruleset-conditions-repository-name-target": { + repository_name: { + /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ + include?: string[]; + /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + /** @description Whether renaming of target repositories is prevented. */ + protected?: boolean; + }; + }; + /** + * Repository ruleset conditions for repository IDs + * @description Parameters for a repository ID condition + */ + "repository-ruleset-conditions-repository-id-target": { + repository_id: { + /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ + repository_ids?: number[]; + }; + }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ name: string; + /** @description The values to match for the repository property */ + property_values: string[]; /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} */ - html_url: string; + source?: "custom" | "system"; + }; + /** + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition + */ + "repository-ruleset-conditions-repository-property-target": { + repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; + }; + /** + * Organization ruleset conditions + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. + */ + "org-ruleset-conditions": + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-name-target"]) + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-id-target"]) + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-property-target"]); + /** + * creation + * @description Only allow users with bypass permission to create matching refs. + */ + "repository-rule-creation": { + /** @enum {string} */ + type: "creation"; + }; + /** + * update + * @description Only allow users with bypass permission to update matching refs. + */ + "repository-rule-update": { + /** @enum {string} */ + type: "update"; + parameters?: { + /** @description Branch can pull changes from its upstream repository */ + update_allows_fetch_and_merge: boolean; + }; + }; + /** + * deletion + * @description Only allow users with bypass permissions to delete matching refs. + */ + "repository-rule-deletion": { + /** @enum {string} */ + type: "deletion"; + }; + /** + * required_linear_history + * @description Prevent merge commits from being pushed to matching refs. + */ + "repository-rule-required-linear-history": { + /** @enum {string} */ + type: "required_linear_history"; + }; + /** + * required_deployments + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. + */ + "repository-rule-required-deployments": { + /** @enum {string} */ + type: "required_deployments"; + parameters?: { + /** @description The environments that must be successfully deployed to before branches can be merged. */ + required_deployment_environments: string[]; + }; + }; + /** + * required_signatures + * @description Commits pushed to matching refs must have verified signatures. + */ + "repository-rule-required-signatures": { + /** @enum {string} */ + type: "required_signatures"; + }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; + /** + * pull_request + * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. + */ + "repository-rule-pull-request": { + /** @enum {string} */ + type: "pull_request"; + parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; + /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ + dismiss_stale_reviews_on_push: boolean; + /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ + require_code_owner_review: boolean; + /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ + require_last_push_approval: boolean; + /** @description The number of approving reviews that are required before a pull request can be merged. */ + required_approving_review_count: number; + /** @description All conversations on code must be resolved before a pull request can be merged. */ + required_review_thread_resolution: boolean; + }; + }; + /** + * StatusCheckConfiguration + * @description Required status check + */ + "repository-rule-params-status-check-configuration": { + /** @description The status check context name that must be present on the commit. */ + context: string; + /** @description The optional integration ID that this status check must originate from. */ + integration_id?: number; + }; + /** + * required_status_checks + * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. + */ + "repository-rule-required-status-checks": { + /** @enum {string} */ + type: "required_status_checks"; + parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; + /** @description Status checks that are required. */ + required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; + /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ + strict_required_status_checks_policy: boolean; + }; + }; + /** + * non_fast_forward + * @description Prevent users with push access from force pushing to refs. + */ + "repository-rule-non-fast-forward": { + /** @enum {string} */ + type: "non_fast_forward"; + }; + /** + * commit_message_pattern + * @description Parameters to be used for the commit_message_pattern rule + */ + "repository-rule-commit-message-pattern": { + /** @enum {string} */ + type: "commit_message_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * commit_author_email_pattern + * @description Parameters to be used for the commit_author_email_pattern rule + */ + "repository-rule-commit-author-email-pattern": { + /** @enum {string} */ + type: "commit_author_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * committer_email_pattern + * @description Parameters to be used for the committer_email_pattern rule + */ + "repository-rule-committer-email-pattern": { + /** @enum {string} */ + type: "committer_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * branch_name_pattern + * @description Parameters to be used for the branch_name_pattern rule + */ + "repository-rule-branch-name-pattern": { + /** @enum {string} */ + type: "branch_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * tag_name_pattern + * @description Parameters to be used for the tag_name_pattern rule + */ + "repository-rule-tag-name-pattern": { + /** @enum {string} */ + type: "tag_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + 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 Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; + /** + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. + */ + "repository-rule-params-code-scanning-tool": { /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - repositories_url: string; - /** @example justice-league */ - slug: string; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - ldap_dn?: string; + security_alerts_threshold: + | "none" + | "critical" + | "high_or_higher" + | "medium_or_higher" + | "all"; + /** @description The name of a code scanning tool */ + tool: string; }; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * code_scanning + * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. */ - "nullable-team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ + "repository-rule-code-scanning": { + /** @enum {string} */ + type: "code_scanning"; + parameters?: { + /** @description Tools that must provide code scanning results for this rule to pass. */ + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; + }; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": + | components["schemas"]["repository-rule-creation"] + | components["schemas"]["repository-rule-update"] + | components["schemas"]["repository-rule-deletion"] + | components["schemas"]["repository-rule-required-linear-history"] + | components["schemas"]["repository-rule-required-deployments"] + | components["schemas"]["repository-rule-required-signatures"] + | components["schemas"]["repository-rule-pull-request"] + | components["schemas"]["repository-rule-required-status-checks"] + | components["schemas"]["repository-rule-non-fast-forward"] + | components["schemas"]["repository-rule-commit-message-pattern"] + | 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-workflows"] + | components["schemas"]["repository-rule-code-scanning"]; + /** + * Repository ruleset + * @description A set of rules to apply when specified conditions are met. + */ + "repository-ruleset": { + /** @description The ID of the ruleset */ id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + /** @description The name of the ruleset */ + name: string; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The target of the ruleset. + * @enum {string} */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + target?: "branch" | "tag" | "push"; /** - * @description Name of the team - * @example Justice League + * @description The type of the source of the ruleset + * @enum {string} */ - name: string; + source_type?: "Repository" | "Organization"; + /** @description The name of the source */ + source: string; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** - * @description Description of the team - * @example A great team. + * @description The bypass type of the user making the API request for this ruleset. This field is only returned when + * querying the repository-level endpoint. + * @enum {string} */ - description: string | null; + current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + node_id?: string; + _links?: { + self?: { + /** @description The URL of the ruleset */ + href?: string; + }; + html?: { + /** @description The html URL of the ruleset */ + href?: string; + } | null; + }; + conditions?: + | ( + | components["schemas"]["repository-ruleset-conditions"] + | components["schemas"]["org-ruleset-conditions"] + ) + | null; + rules?: components["schemas"]["repository-rule"][]; + /** Format: date-time */ + created_at?: string; + /** 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; /** - * @description Permission that the team will have for its repositories - * @example admin + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - permission: string; + pushed_at?: string; /** - * @description The level of privacy this team should have - * @example closed + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - privacy?: string; + result?: "pass" | "fail" | "bypass"; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @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} */ - notification_setting?: 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 | null; + /** @description The handle for the GitHub user account. */ + actor_name?: string | null; + /** @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: uri - * @example https://github.com/orgs/rails/teams/core + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - html_url: string; + pushed_at?: string; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - repositories_url: string; - /** @example justice-league */ - slug: string; + result?: "pass" | "fail" | "bypass"; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @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`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - ldap_dn?: string; - } | null; + evaluation_result?: "pass" | "fail" | null; + /** @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 The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; + }[]; + }; /** * Team * @description Groups of organization members that gives permissions on specified repositories. @@ -15024,6 +17174,8 @@ export interface components { web_commit_signoff_required?: boolean; /** Format: date-time */ updated_at: string; + /** Format: date-time */ + archived_at: string | null; }; /** * Full Team @@ -15627,6 +17779,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -15742,6 +17895,7 @@ export interface components { code_scanning_upload?: components["schemas"]["rate-limit"]; actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -16069,6 +18223,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -16076,6 +18231,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -16085,6 +18241,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -16356,6 +18513,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -16407,6 +18565,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -16520,6 +18679,50 @@ export interface components { */ deleted_at?: string; }; + /** + * Activity + * @description Activity + */ + activity: { + /** @example 1296269 */ + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; + /** + * @description The SHA of the commit before the activity. + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + before: string; + /** + * @description The SHA of the commit after the activity. + * @example 827efc6d56897b048c772eb4087f854f46256132 + */ + after: string; + /** + * @description The full Git reference, formatted as `refs/heads/`. + * @example refs/heads/main + */ + ref: string; + /** + * Format: date-time + * @description The time when the activity occurred. + * @example 2011-01-26T19:06:43Z + */ + timestamp: string; + /** + * @description The type of the activity that was performed. + * @example force_push + * @enum {string} + */ + activity_type: + | "push" + | "force_push" + | "branch_deletion" + | "branch_creation" + | "pr_merge" + | "merge_queue_merge"; + actor: components["schemas"]["nullable-simple-user"]; + }; /** * Autolink reference * @description An autolink reference. @@ -16648,6 +18851,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -16665,6 +18869,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -16720,8 +18925,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -16915,8 +19123,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -17134,6 +19348,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -17291,7 +19506,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -17396,7 +19614,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -17496,6 +19714,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -17518,6 +19737,11 @@ export interface components { * @example 2023-12-06T14:20:20.000Z */ updated_at?: string | null; + /** + * @description The frequency of the periodic analysis. + * @enum {string|null} + */ + schedule?: "weekly" | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup-update": { @@ -17525,7 +19749,7 @@ export interface components { * @description The desired state of code scanning default setup. * @enum {string} */ - state: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description CodeQL query suite to be used. * @enum {string} @@ -17533,6 +19757,7 @@ export interface components { query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -17540,8 +19765,8 @@ export interface components { | "javascript-typescript" | "python" | "ruby" + | "swift" )[]; - [key: string]: unknown; }; /** * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. @@ -17559,7 +19784,7 @@ export interface components { * @example refs/heads/main */ "code-scanning-ref-full": string; - /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.10/code-security/secure-coding/sarif-support-for-code-scanning)." */ + /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.14/code-security/secure-coding/sarif-support-for-code-scanning)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { id?: components["schemas"]["code-scanning-analysis-sarif-id"]; @@ -17636,7 +19861,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -17704,6 +19932,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; }; /** * Collaborator @@ -17712,7 +19942,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -17780,6 +20013,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -17860,7 +20095,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -18095,6 +20333,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -18108,7 +20347,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -18312,6 +20550,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -18346,6 +20600,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -18458,6 +20713,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -18477,11 +20737,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -18492,7 +20750,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -18529,6 +20787,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -18547,6 +20810,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -18674,7 +20948,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -18706,7 +20983,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -18765,6 +21042,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -18808,6 +21086,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. */ @@ -18829,23 +21112,34 @@ 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": { @@ -18857,6 +21151,12 @@ export interface components { * @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": { @@ -19221,6 +21521,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -19357,6 +21658,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -19774,6 +22076,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -19790,14 +22093,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -20008,11 +22317,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -20033,12 +22344,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -20515,10 +22826,12 @@ export interface components { * @description The GitHub Pages deployment status. */ "page-deployment": { + /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ + id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. - * @example https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251 + * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ status_url: string; /** @@ -20534,6 +22847,25 @@ export interface components { */ preview_url?: string; }; + /** GitHub Pages deployment status */ + "pages-deployment-status": { + /** + * @description The current status of the deployment. + * @enum {string} + */ + status?: + | "deployment_in_progress" + | "syncing_files" + | "finished_file_sync" + | "updating_pages" + | "purging_cdn" + | "deployment_cancelled" + | "deployment_failed" + | "deployment_content_failed" + | "deployment_attempt_error" + | "deployment_lost" + | "succeed"; + }; "repository-pre-receive-hook": { id?: number; name?: string; @@ -20550,7 +22882,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -20659,359 +22994,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -21079,6 +23071,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -21132,9 +23125,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -21312,6 +23311,58 @@ export interface components { /** @description The generated body describing the contents of the release supporting markdown formatting */ body: string; }; + /** + * repository ruleset data for rule + * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + */ + "repository-rule-ruleset-info": { + /** + * @description The type of source for the ruleset that includes this rule. + * @enum {string} + */ + ruleset_source_type?: "Repository" | "Organization"; + /** @description The name of the source of the ruleset that includes this rule. */ + ruleset_source?: string; + /** @description The ID of the ruleset that includes this rule. */ + ruleset_id?: number; + }; + /** + * Repository Rule + * @description A repository rule with ruleset details. + */ + "repository-rule-detailed": + | (components["schemas"]["repository-rule-creation"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-update"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-deletion"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-linear-history"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-deployments"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-signatures"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-pull-request"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-status-checks"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-non-fast-forward"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-commit-message-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-commit-author-email-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-committer-email-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (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"]) + | (components["schemas"]["repository-rule-code-scanning"] & + components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -21337,7 +23388,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -21350,6 +23401,11 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -21383,6 +23439,42 @@ export interface components { /** @description The API URL to get the associated commit resource */ commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** @@ -21442,7 +23534,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -21451,7 +23543,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -21488,8 +23580,9 @@ export interface components { * @example commit * @enum {string} */ - type: + type?: | "commit" + | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" @@ -21501,8 +23594,9 @@ export interface components { | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; - details: + details?: | components["schemas"]["secret-scanning-location-commit"] + | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] @@ -22139,6 +24233,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -22365,6 +24465,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -22410,6 +24511,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; "configuration-status": { status?: string; @@ -22575,8 +24677,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -22645,6 +24751,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -22686,8 +24797,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -22713,7 +24822,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -22753,6 +24865,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -22794,6 +24907,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -22854,7 +24968,7 @@ export interface components { * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts)." + * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.14/admin/overview/about-enterprise-accounts)." */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -22903,7 +25017,7 @@ export interface components { * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.14/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -22964,6 +25078,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -23164,6 +25279,10 @@ export interface components { */ is_template?: boolean; topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -23399,7 +25518,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -23462,7 +25581,7 @@ export interface components { }; /** * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. */ webhooks_rule: { admin_enforced: boolean; @@ -23514,73 +25633,146 @@ export interface components { updated_at: string; }; /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. + * Push ruleset bypass exemption request data + * @description Push rules that are being requested to be bypassed. */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; + "exemption-request-push-ruleset-bypass": { /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif + * @description The type of request + * @enum {string} */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + type?: "push_ruleset_bypass"; + /** @description The data pertaining to the push rules that are being requested to be bypassed. */ + data?: { + /** @description The ID of the ruleset for the rules that were violated */ + ruleset_id?: number; + /** @description The name of the ruleset for the rules that were violated */ + ruleset_name?: string; + /** @description The number of violations */ + total_violations?: number; + /** @description The type of rule that was violated */ + rule_type?: string; + }[]; + }; + /** + * Secret scanning push protection exemption request data + * @description Secret scanning push protections that are being requested to be bypassed. + */ + "exemption-request-secret-scanning": { /** - * Format: uri - * @example https://api.github.com/users/octocat + * @description The type of request + * @enum {string} */ - url: string; + type?: "secret_scanning"; + /** @description The data pertaining to the secret scanning push protections that are being requested to be bypassed. */ + data?: { + /** @description The type of secret that was detected */ + secret_type?: string; + /** @description The location data of the secret that was detected */ + locations?: { + /** @description The commit SHA where the secret was detected */ + commit?: string; + /** @description The branch where the secret was detected */ + branch?: string; + /** @description The path of the file where the secret was detected */ + path?: string; + }[]; + }[]; + }; + /** + * Secret Scanning Push Protection Exemption Request Metadata + * @description Metadata for a secret scanning push protection exemption request. + */ + "exemption-request-secret-scanning-metadata": { + /** @description The label for the secret type */ + label?: string; /** - * Format: uri - * @example https://github.com/octocat + * @description The reason for the exemption request + * @enum {string} */ - html_url: string; + reason?: "fixed_later" | "false_positive" | "tests"; + }; + /** + * Exemption response + * @description A response to an exemption request by a delegated bypasser. + */ + "exemption-response": { + /** @description The ID of the exemption response. */ + id?: number; + /** @description The ID of the user who reviewed the exemption request. */ + reviewer_id?: number; + /** @description The login of the user who reviewed the exemption request. */ + reviewer_login?: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description The status of the exemption response. + * @enum {string} */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + status?: "approved" | "rejected" | "dismissed"; + /** @description The comment the reviewer provided when responding to the exemption request. */ + reviewer_comment?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * Format: date-time + * @description The date and time the exemption request was created. */ - subscriptions_url: string; + created_at?: string; + }; + /** + * Exemption Request + * @description A request from a user to be exempted from a set of rules. + */ + "exemption-request": { + /** @description The ID of the exemption request. */ + id?: number; + /** @description The number uniquely identifying the exemption request within it's repository. */ + number?: number; + /** @description The ID of the repository the exemption request is for. */ + repository_id?: number; + /** @description The ID of the user who requested the exemption. */ + requester_id?: number; + /** @description The login of the user who requested the exemption. */ + requester_login?: string; + /** + * @description The type of request. + * @enum {string} + */ + request_type?: "push_ruleset_bypass" | "secret_scanning"; + exemption_request_data?: + | components["schemas"]["exemption-request-push-ruleset-bypass"] + | components["schemas"]["exemption-request-secret-scanning"]; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The unique identifier for the request type of the exemption request. For example, a commit SHA. + * @example 827efc6d56897b048c772eb4087f854f46256132 */ - organizations_url: string; + resource_identifier?: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * @description The status of the exemption request. + * @enum {string} */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + status?: "pending" | "rejected" | "cancelled" | "completed"; + /** @description The comment the requester provided when creating the exemption request. */ + requester_comment?: string | null; + /** @description Metadata about the exemption request. */ + metadata?: + | components["schemas"]["exemption-request-secret-scanning-metadata"] + | null; + /** + * Format: date-time + * @description The date and time the exemption request will expire. + */ + expires_at?: string; + /** + * Format: date-time + * @description The date and time the exemption request was created. + */ + created_at?: string; + /** @description The responses to the exemption request. */ + responses?: components["schemas"]["exemption-response"][] | null; /** * Format: uri - * @example https://api.github.com/users/octocat/received_events + * @description The URL to view the exemption request in a browser. + * @example https://github.com/monalisa/smile/exemptions/1 */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; + html_url?: string; }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { @@ -23711,9 +25903,9 @@ export interface components { webhooks_code_scanning_ref: string; /** @description The pusher type for the event. Can be either `user` or a deploy key. */ webhooks_deploy_pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/enterprise-server@3.10/rest/git/refs#get-a-reference) resource. */ + /** @description The [`git ref`](https://docs.github.com/enterprise-server@3.14/rest/git/refs#get-a-reference) resource. */ webhooks_ref_0: string; - /** @description The [`deploy key`](https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ + /** @description The [`deploy key`](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ webhooks_deploy_key: { added_by?: string | null; created_at: string; @@ -23763,6 +25955,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -23832,6 +26025,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -23851,6 +26045,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -23910,6 +26105,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -23929,6 +26125,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -23974,6 +26171,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -24061,6 +26259,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24080,7 +26279,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -24138,6 +26339,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24157,6 +26359,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -24204,7 +26407,7 @@ export interface components { webhooks_repository_selection: "all" | "selected"; /** * issue comment - * @description The [comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment) itself. */ webhooks_issue_comment: { /** @@ -24274,6 +26477,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24293,6 +26497,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -24304,7 +26509,7 @@ export interface components { }; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ webhooks_issue: { /** @enum {string|null} */ @@ -24350,6 +26555,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -24386,6 +26592,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -24481,6 +26688,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -24611,6 +26819,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -24718,6 +26927,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -24752,6 +26967,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24771,6 +26987,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -24819,6 +27036,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -24846,7 +27064,7 @@ export interface components { }; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ webhooks_issue_2: { /** @enum {string|null} */ @@ -24892,6 +27110,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -24928,6 +27147,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -25023,6 +27243,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -25151,6 +27372,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -25258,6 +27480,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -25292,6 +27520,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25311,6 +27540,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -25349,6 +27579,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Team @@ -25421,6 +27652,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -25621,6 +27853,10 @@ export interface components { */ is_template?: boolean; topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -25856,7 +28092,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -25963,6 +28199,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26016,6 +28253,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26035,6 +28273,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26103,6 +28342,10 @@ export interface components { | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -26158,6 +28401,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -26214,6 +28458,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -26330,6 +28575,26 @@ export interface components { */ archived_at: string | null; }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-option": { + id: string; + name: string; + color?: string | null; + description?: string | null; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-setting": { + id: string; + title: string; + duration?: number | null; + start_date?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -26376,7 +28641,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -26469,6 +28734,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -26565,6 +28831,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -26692,7 +28959,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -26785,6 +29055,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -26874,6 +29145,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26893,6 +29165,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -27032,7 +29305,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -27125,6 +29401,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -27214,6 +29491,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27233,6 +29511,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -27300,6 +29579,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -27347,6 +29627,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -27555,6 +29836,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27574,11 +29856,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ webhooks_review_comment: { _links: { @@ -27708,6 +29991,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27727,6 +30011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -27788,6 +30073,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27807,12 +30093,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release) object. */ webhooks_release: { assets: { @@ -27913,6 +30200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -27959,7 +30247,7 @@ export interface components { }; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release) object. */ webhooks_release_1: { assets: ({ @@ -28060,6 +30348,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -28200,6 +30489,11 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} @@ -28220,6 +30514,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -28272,6 +30567,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -28311,6 +30607,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -28348,6 +30645,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -28453,6 +30751,26 @@ export interface components { */ url?: string; }; + /** branch protection configuration disabled event */ + "webhook-branch-protection-configuration-disabled": { + /** @enum {string} */ + action: "disabled"; + 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"]; + }; + /** branch protection configuration enabled event */ + "webhook-branch-protection-configuration-enabled": { + /** @enum {string} */ + action: "enabled"; + 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"]; + }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { /** @enum {string} */ @@ -28462,7 +30780,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -28473,7 +30791,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -28497,6 +30815,13 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -28510,7 +30835,64 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request cancellation event */ + "webhook-exemption-request-cancelled": { + /** @enum {string} */ + action: "cancelled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request completed event */ + "webhook-exemption-request-completed": { + /** @enum {string} */ + action: "completed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request created event */ + "webhook-exemption-request-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"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption response dismissed event */ + "webhook-exemption-request-response-dismissed": { + /** @enum {string} */ + action: "response_dismissed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + exemption_response: components["schemas"]["exemption-response"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption response submitted event */ + "webhook-exemption-request-response-submitted": { + /** @enum {string} */ + action: "response_submitted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + exemption_response: components["schemas"]["exemption-response"]; + sender: components["schemas"]["simple-user"]; }; "webhook-cache-sync": { after: string; @@ -28521,7 +30903,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -28531,7 +30913,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -28549,7 +30931,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -28572,7 +30954,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -28590,7 +30972,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -28604,7 +30986,7 @@ export interface components { "webhook-check-suite-completed": { /** @enum {string} */ action: "completed"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -28676,6 +31058,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -28715,6 +31099,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -28908,13 +31293,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { /** @enum {string} */ action: "requested"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -28987,6 +31372,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -29026,6 +31413,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -29212,13 +31600,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { /** @enum {string} */ action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -29286,6 +31674,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -29325,6 +31715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -29510,7 +31901,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -29564,6 +31955,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -29640,7 +32032,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -29694,6 +32086,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -29777,7 +32170,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -29852,9 +32245,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -29872,7 +32265,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -29926,6 +32319,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -30011,7 +32405,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -30104,7 +32498,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -30188,7 +32582,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -30197,7 +32591,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -30264,6 +32658,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -30283,13 +32678,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; 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"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -30308,7 +32704,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** delete event */ "webhook-delete": { @@ -30323,7 +32719,29 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert auto-dismissed event */ + "webhook-dependabot-alert-auto-dismissed": { + /** @enum {string} */ + action: "auto_dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert auto-reopened event */ + "webhook-dependabot-alert-auto-reopened": { + /** @enum {string} */ + action: "auto_reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -30334,7 +32752,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -30345,7 +32763,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -30356,7 +32774,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -30367,7 +32785,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -30378,7 +32796,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -30389,7 +32807,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -30400,7 +32818,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -30408,7 +32826,7 @@ export interface components { action: "created"; /** * Deployment - * @description The [deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -30448,6 +32866,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -30561,6 +32980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -30657,7 +33077,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -30697,6 +33117,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -30947,6 +33368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -30974,7 +33396,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -30986,7 +33408,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -31037,6 +33459,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -31113,6 +33536,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31225,6 +33649,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31287,6 +33712,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -31306,7 +33732,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -31357,6 +33783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -31432,6 +33859,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31544,6 +33972,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31605,6 +34034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -31661,11 +34091,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -31715,6 +34146,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -31790,6 +34222,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31902,6 +34335,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31964,6 +34398,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32019,7 +34454,7 @@ export interface components { } | null; /** * Deployment - * @description The [deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -32059,6 +34494,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -32172,6 +34608,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -32264,7 +34701,7 @@ export interface components { /** Format: uri */ url: string; }; - /** @description The [deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#list-deployment-statuses). */ + /** @description The [deployment status](https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; /** User */ @@ -32303,6 +34740,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -32421,6 +34859,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -32514,7 +34953,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -32554,6 +34993,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -32805,6 +35245,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32824,7 +35265,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -32852,7 +35293,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -32863,7 +35304,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -32875,7 +35316,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -32887,7 +35328,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -32904,7 +35345,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -32915,7 +35356,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -32926,7 +35367,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -32945,7 +35386,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -32957,7 +35398,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -32968,7 +35409,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -32979,7 +35420,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -32990,7 +35431,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -33005,7 +35446,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -33015,7 +35456,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -33027,7 +35468,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -33038,7 +35479,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -33049,17 +35490,17 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-disabled": { /** @enum {string} */ action: "anonymous_access_disabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-enabled": { /** @enum {string} */ action: "anonymous_access_enabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** * fork event @@ -33067,7 +35508,7 @@ export interface components { */ "webhook-fork": { enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The created [`repository`](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository) resource. */ + /** @description The created [`repository`](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository) resource. */ forkee: { /** * @description Whether to allow auto-merge for pull requests. @@ -33120,10 +35561,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -33180,7 +35617,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -33256,6 +35696,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -33407,13 +35848,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -33441,7 +35882,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -33453,7 +35894,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -33465,7 +35906,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -33477,7 +35918,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -33501,7 +35942,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -33525,7 +35966,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -33537,10 +35978,11 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { + archived_at?: string | null; avatar_url: string; created_at?: string; description?: unknown; @@ -33576,6 +36018,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -33591,7 +36034,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -33604,7 +36047,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -33612,7 +36055,7 @@ export interface components { action: "created"; /** * issue comment - * @description The [comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -33682,6 +36125,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33701,11 +36145,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -33750,6 +36195,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -33786,6 +36232,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -33881,6 +36328,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34011,6 +36459,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34118,6 +36567,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -34152,6 +36607,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34171,6 +36627,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -34210,6 +36667,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -34272,6 +36730,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -34287,7 +36746,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -34296,7 +36755,7 @@ export interface components { comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -34341,6 +36800,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -34377,6 +36837,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34472,6 +36933,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34600,6 +37062,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34707,6 +37170,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -34741,6 +37210,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34760,6 +37230,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -34799,6 +37270,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -34861,6 +37333,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -34872,11 +37345,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -34886,7 +37360,7 @@ export interface components { comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -34931,6 +37405,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -34967,6 +37442,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35062,6 +37538,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35192,6 +37669,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35299,6 +37777,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35333,6 +37817,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35352,6 +37837,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -35391,6 +37877,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -35453,6 +37940,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -35468,7 +37956,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -35483,7 +37971,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -35494,7 +37982,7 @@ export interface components { action: "closed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -35539,6 +38027,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35575,6 +38064,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35670,6 +38160,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35801,6 +38292,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35908,6 +38400,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35942,6 +38440,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35961,6 +38460,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36009,6 +38509,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36020,11 +38521,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -36034,7 +38536,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36080,6 +38582,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36211,6 +38714,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36340,6 +38844,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36447,6 +38952,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36481,6 +38992,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36500,11 +39012,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -36514,7 +39027,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36691,6 +39204,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36819,6 +39333,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36926,6 +39441,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36960,6 +39481,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36979,12 +39501,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -37005,7 +39528,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -37051,6 +39574,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37182,6 +39706,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37313,6 +39838,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37420,6 +39946,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37454,6 +39986,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37473,12 +40006,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -37488,7 +40022,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -37534,6 +40068,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37665,6 +40200,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37795,6 +40331,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37902,6 +40439,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37936,6 +40479,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37955,12 +40499,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -37970,7 +40515,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -38016,6 +40561,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38052,6 +40598,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -38148,6 +40695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38278,6 +40826,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38385,6 +40934,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38419,6 +40974,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38438,11 +40994,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -38452,7 +41009,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -38629,6 +41186,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38758,6 +41316,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38865,6 +41424,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38899,6 +41464,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38918,12 +41484,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -38932,7 +41499,7 @@ export interface components { changes?: { /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ old_issue: { /** @enum {string|null} */ @@ -38978,6 +41545,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39014,6 +41582,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -39109,6 +41678,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39237,6 +41807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39344,6 +41915,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39378,6 +41955,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39397,6 +41975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -39455,6 +42034,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -39513,7 +42096,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -39589,6 +42175,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -39643,7 +42230,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -39689,6 +42276,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39725,6 +42313,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -39820,6 +42409,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39951,6 +42541,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40058,6 +42649,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40092,6 +42689,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40111,11 +42709,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -40126,7 +42725,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -40136,7 +42735,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -40313,6 +42912,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40443,6 +43043,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40550,6 +43151,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40584,6 +43191,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40603,11 +43211,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -40616,7 +43225,7 @@ export interface components { changes: { /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ new_issue: { /** @enum {string|null} */ @@ -40662,6 +43271,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40698,6 +43308,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40793,6 +43404,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40921,6 +43533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41028,6 +43641,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41062,6 +43681,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41081,6 +43701,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -41139,6 +43760,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -41200,7 +43825,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -41276,6 +43904,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -41331,7 +43960,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -41346,7 +43975,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -41358,7 +43987,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -41368,7 +43997,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -41414,6 +44043,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41450,6 +44080,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -41546,6 +44177,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41674,6 +44306,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41781,6 +44414,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41815,6 +44454,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41834,11 +44474,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -41849,7 +44490,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -41860,7 +44501,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -41871,7 +44512,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -41897,7 +44538,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -41924,7 +44565,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -41946,7 +44587,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -41957,7 +44598,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -42009,6 +44650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -42062,6 +44704,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -42146,7 +44789,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -42157,7 +44800,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -42168,7 +44811,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -42179,7 +44822,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -42205,7 +44848,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -42216,7 +44859,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -42227,7 +44870,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -42238,7 +44881,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -42293,6 +44936,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -42302,7 +44946,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -42314,7 +44958,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -42330,7 +44974,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -42404,6 +45048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -42443,6 +45088,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -42580,6 +45226,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -42615,7 +45262,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -42670,6 +45317,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -42709,6 +45357,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -42780,6 +45429,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -42816,11 +45466,11 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.10/rest/pages/pages#list-github-pages-builds) itself. */ + /** @description The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.14/rest/pages/pages#list-github-pages-builds) itself. */ build: { commit: string | null; created_at: string; @@ -42864,6 +45514,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -42875,15 +45526,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { /** @enum {string} */ action: "approved"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -42891,8 +45543,9 @@ export interface components { /** @enum {string} */ action: "cancelled"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -42900,9 +45553,10 @@ export interface components { /** @enum {string} */ action: "created"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ "webhook-personal-access-token-request-denied": { @@ -42910,7 +45564,8 @@ export interface components { action: "denied"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -42957,7 +45612,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -42980,7 +45635,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -42991,7 +45646,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -43048,6 +45703,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -43061,7 +45717,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -43077,7 +45733,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -43138,6 +45794,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -43183,7 +45840,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -43194,7 +45851,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -43205,7 +45862,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -43216,7 +45873,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -43232,7 +45889,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -43243,7 +45900,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -43254,7 +45911,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -43265,7 +45922,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -43287,7 +45944,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -43298,7 +45955,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -43307,7 +45964,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -43316,7 +45973,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -43325,7 +45982,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -43352,7 +46009,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -43362,7 +46019,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -43377,7 +46034,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -43386,7 +46043,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -43395,18 +46052,36 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { field_value: { field_node_id?: string; field_type?: string; + field_name?: string; + project_number?: number; + from?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; + to?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; }; }, { @@ -43420,7 +46095,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -43435,7 +46110,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -43445,7 +46120,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -43454,7 +46129,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -43462,7 +46137,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -43561,6 +46236,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43597,6 +46273,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43657,6 +46334,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -43784,7 +46462,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -43877,6 +46558,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43940,7 +46622,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -43969,6 +46651,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43988,6 +46671,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -44127,7 +46811,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -44220,6 +46907,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -44283,7 +46971,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -44312,6 +47000,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44331,6 +47020,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -44398,6 +47088,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -44445,6 +47136,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -44513,6 +47205,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -44653,6 +47346,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44672,10 +47366,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -44773,6 +47468,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44869,6 +47565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -44996,7 +47693,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -45089,6 +47789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45152,7 +47853,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -45181,6 +47882,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45200,6 +47902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -45339,7 +48042,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -45432,6 +48138,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45495,7 +48202,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -45524,6 +48231,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45543,6 +48251,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -45610,6 +48319,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -45657,6 +48367,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45725,6 +48436,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -45865,6 +48577,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45884,11 +48597,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -45986,6 +48700,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46082,6 +48797,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -46209,7 +48925,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46302,6 +49021,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46365,7 +49085,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46394,6 +49114,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46413,6 +49134,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -46645,6 +49367,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46708,7 +49431,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46737,6 +49460,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46756,6 +49480,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -46823,6 +49548,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -46870,6 +49596,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46938,6 +49665,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -47078,6 +49806,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47097,11 +49826,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -47113,7 +49843,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -47125,7 +49855,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -47137,7 +49867,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -47168,7 +49898,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -47267,6 +49997,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47363,6 +50094,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -47490,7 +50222,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47583,6 +50318,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47646,7 +50382,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47675,6 +50411,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47694,6 +50431,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -47833,7 +50571,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47926,6 +50667,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47989,7 +50731,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48018,6 +50760,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48037,6 +50780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -48104,6 +50848,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -48151,6 +50896,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48219,6 +50965,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -48359,6 +51106,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48378,10 +51126,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -48479,6 +51228,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48575,6 +51325,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48702,7 +51453,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48795,6 +51549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48858,7 +51613,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48887,6 +51642,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48906,6 +51662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -49045,7 +51802,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49138,6 +51898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49201,7 +51962,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49230,6 +51991,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49249,6 +52011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -49316,6 +52079,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -49363,6 +52127,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49431,6 +52196,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -49571,6 +52337,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49590,10 +52357,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -49605,7 +52373,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -49617,7 +52385,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -49629,7 +52397,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -49641,7 +52409,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -49649,7 +52417,7 @@ export interface components { action: "created"; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -49779,6 +52547,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49798,6 +52567,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -49889,6 +52659,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49985,6 +52756,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -50112,7 +52884,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50205,6 +52980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50268,7 +53044,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50297,6 +53073,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50316,6 +53093,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -50448,7 +53226,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50541,6 +53322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50604,7 +53386,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50633,6 +53415,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50652,6 +53435,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50723,6 +53507,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50789,6 +53574,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50923,6 +53709,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50942,10 +53729,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -51041,6 +53829,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -51137,6 +53926,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -51264,7 +54054,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51357,6 +54150,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51420,7 +54214,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51449,6 +54243,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51468,6 +54263,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51600,7 +54396,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51693,6 +54492,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51756,7 +54556,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51785,6 +54585,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51804,6 +54605,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -51875,6 +54677,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51941,6 +54744,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -52075,6 +54879,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52094,10 +54899,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -52194,6 +55000,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52230,6 +55037,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52290,6 +55098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52417,7 +55226,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52510,6 +55322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52573,7 +55386,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52602,6 +55415,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52621,6 +55435,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52753,7 +55568,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52846,6 +55664,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52909,7 +55728,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52938,6 +55757,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52957,6 +55777,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -53028,6 +55849,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53094,6 +55916,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53228,6 +56051,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53245,12 +56069,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -53346,6 +56171,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53442,6 +56268,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53569,7 +56396,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53662,6 +56492,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53725,7 +56556,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53754,6 +56585,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53773,6 +56605,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53905,7 +56738,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53998,6 +56834,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54061,7 +56898,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54090,6 +56927,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54109,6 +56947,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54180,6 +57019,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54246,6 +57086,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -54380,6 +57221,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54399,6 +57241,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -54462,6 +57305,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54481,9 +57325,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -54585,6 +57430,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54681,6 +57527,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54803,7 +57650,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54879,6 +57729,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54944,6 +57795,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54963,6 +57815,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55090,7 +57943,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55166,6 +58022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55231,6 +58088,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55250,6 +58108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55321,6 +58180,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55387,6 +58247,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -55521,6 +58382,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55540,11 +58402,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -55645,6 +58508,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55681,6 +58545,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -55741,6 +58606,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55868,7 +58734,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55961,6 +58830,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56017,7 +58887,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56046,6 +58916,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56065,6 +58936,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56204,7 +59076,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56297,6 +59172,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56360,7 +59236,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56389,6 +59265,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56408,6 +59285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56475,6 +59353,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -56522,6 +59401,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56590,6 +59470,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56730,6 +59611,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56749,6 +59631,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -56788,8 +59671,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -56887,6 +59771,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56923,6 +59808,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -56983,6 +59869,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57110,7 +59997,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57203,6 +60093,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57266,7 +60157,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57295,6 +60186,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57314,6 +60206,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -57453,7 +60346,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57546,6 +60442,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57609,7 +60506,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57638,6 +60535,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57657,6 +60555,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57724,6 +60623,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57771,6 +60671,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57839,6 +60740,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -57979,6 +60881,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57998,6 +60901,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -58056,7 +60960,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -58159,6 +61063,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58195,6 +61100,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -58255,6 +61161,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -58382,7 +61289,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58475,6 +61385,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58538,7 +61449,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58567,6 +61478,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58586,6 +61498,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58725,7 +61638,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58818,6 +61734,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58881,7 +61798,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58910,6 +61827,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58929,6 +61847,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58996,6 +61915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -59043,6 +61963,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59111,6 +62032,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -59251,6 +62173,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59270,6 +62193,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -59309,8 +62233,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -59408,6 +62333,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59444,6 +62370,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -59504,6 +62431,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59631,7 +62559,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59724,6 +62655,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59787,7 +62719,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -59816,6 +62748,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59835,6 +62768,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59974,7 +62908,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60067,6 +63004,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60130,7 +63068,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60159,6 +63097,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60178,6 +63117,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60245,6 +63185,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -60292,6 +63233,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60360,6 +63302,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -60500,6 +63443,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60519,6 +63463,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -60577,7 +63522,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -60675,6 +63620,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60771,6 +63717,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60898,7 +63845,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60991,6 +63941,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61054,7 +64005,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61083,6 +64034,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61102,6 +64054,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61234,7 +64187,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61327,6 +64283,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61390,7 +64347,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61419,6 +64376,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61438,6 +64396,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61509,6 +64468,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61575,6 +64535,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61709,6 +64670,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61728,11 +64690,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -61828,6 +64791,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61924,6 +64888,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62051,7 +65016,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62127,6 +65095,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62194,6 +65163,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62213,6 +65183,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62345,7 +65316,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62421,6 +65395,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62488,6 +65463,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62507,6 +65483,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62578,6 +65555,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62644,6 +65622,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -62778,6 +65757,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62797,10 +65777,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -62930,6 +65911,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62949,6 +65931,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -63048,6 +66031,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63144,6 +66128,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63271,7 +66256,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63347,6 +66335,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63414,6 +66403,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63433,6 +66423,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63565,7 +66556,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63641,6 +66635,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63708,6 +66703,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63727,6 +66723,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63798,6 +66795,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63864,6 +66862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -63998,6 +66997,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64017,10 +67017,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -64150,6 +67151,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64169,6 +67171,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -64272,6 +67275,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64368,6 +67372,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64495,7 +67500,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64588,6 +67596,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64651,7 +67660,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64680,6 +67689,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64699,6 +67709,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64838,7 +67849,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64924,6 +67938,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64987,7 +68002,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65016,6 +68031,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65035,6 +68051,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65102,6 +68119,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -65149,6 +68167,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65217,6 +68236,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -65357,6 +68377,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65376,10 +68397,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -65478,6 +68500,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65574,6 +68597,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65701,7 +68725,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65794,6 +68821,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65857,7 +68885,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65886,6 +68914,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65905,6 +68934,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66044,7 +69074,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66137,6 +69170,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66200,7 +69234,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66229,6 +69263,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66248,6 +69283,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66315,6 +69351,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -66362,6 +69399,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66430,6 +69468,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -66570,6 +69609,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66589,10 +69629,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -66691,6 +69732,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66787,6 +69829,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66914,7 +69957,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67007,6 +70053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67070,7 +70117,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -67099,6 +70146,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67118,6 +70166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67257,7 +70306,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67343,6 +70395,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67406,7 +70459,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -67435,6 +70488,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67454,6 +70508,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67521,6 +70576,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -67568,6 +70624,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67636,6 +70693,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67776,6 +70834,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67795,10 +70854,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -67896,6 +70956,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67992,6 +71053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68119,7 +71181,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68212,6 +71277,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68275,7 +71341,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68304,6 +71370,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68323,6 +71390,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68462,7 +71530,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68555,6 +71626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68618,7 +71690,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68647,6 +71719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68666,6 +71739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68733,6 +71807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -68780,6 +71855,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68848,6 +71924,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -68988,6 +72065,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69007,10 +72085,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -69019,7 +72098,7 @@ export interface components { base_ref: components["schemas"]["webhooks_nullable_string"]; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.10/rest/commits) to fetch additional commits. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.14/rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -69203,6 +72282,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -69264,7 +72347,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69340,6 +72426,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69389,7 +72476,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -69424,6 +72511,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -69446,6 +72534,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -69564,6 +72653,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -69594,7 +72684,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -69629,6 +72719,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -69651,6 +72742,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -69703,6 +72795,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -69727,7 +72820,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -69738,7 +72831,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -69749,7 +72842,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -69774,7 +72867,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -69785,7 +72878,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -69886,6 +72979,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -69934,7 +73028,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -69945,7 +73039,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -69956,7 +73050,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -69967,7 +73061,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-disabled": { /** @enum {string} */ @@ -69976,7 +73070,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-enabled": { /** @enum {string} */ @@ -69985,7 +73079,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -69995,7 +73089,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -70005,7 +73099,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -70015,7 +73109,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -70030,7 +73124,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -70054,7 +73148,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository privatized event */ "webhook-repository-privatized": { @@ -70064,7 +73158,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -70074,7 +73168,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -70091,7 +73185,87 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset created event */ + "webhook-repository-ruleset-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"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset deleted event */ + "webhook-repository-ruleset-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"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset edited event */ + "webhook-repository-ruleset-edited": { + /** @enum {string} */ + action: "edited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; + }; + target?: { + from?: string; + }; + include?: { + from?: string[]; + }; + exclude?: { + from?: string[]; + }; + }; + }[]; + }; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; + }; + rule_type?: { + from?: string; + }; + pattern?: { + from?: string; + }; + }; + }[]; + }; + }; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -70142,6 +73316,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70161,6 +73336,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -70169,7 +73345,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -70179,7 +73355,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -70190,7 +73366,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -70243,6 +73419,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -70263,7 +73440,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -70274,7 +73451,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -70346,7 +73523,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -70357,7 +73534,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -70368,7 +73545,7 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { @@ -70384,7 +73561,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -70395,18 +73572,18 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - action: "revoked"; + action: "validated"; alert: components["schemas"]["secret-scanning-alert-webhook"]; 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"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -70417,7 +73594,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -70428,7 +73605,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -70444,6 +73621,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -70475,7 +73653,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -70488,7 +73666,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -70498,7 +73676,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -70509,7 +73687,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -70526,7 +73704,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -70538,7 +73716,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -70551,7 +73729,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -70563,7 +73741,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -70574,7 +73752,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -70586,7 +73764,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -70765,7 +73943,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -70783,7 +73961,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -70849,6 +74027,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -70905,7 +74087,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70981,6 +74166,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71028,7 +74214,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -71094,6 +74280,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -71150,252 +74340,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** 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; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - }; - sender: components["schemas"]["simple-user-webhooks"]; - team: components["schemas"]["webhooks_team_1"]; - }; - /** team deleted event */ - "webhook-team-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - /** - * Repository - * @description A git repository - */ - repository?: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; /** - * @description Whether the wiki is enabled. - * @default true + * Format: int64 + * @description Unique identifier of the repository */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71471,6 +74419,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71518,7 +74467,260 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; + }; + /** team deleted event */ + "webhook-team-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + /** + * Repository + * @description A git repository + */ + repository?: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** 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; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + }; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -71615,6 +74817,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -71671,7 +74877,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71747,6 +74956,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71794,7 +75004,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -71860,6 +75070,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -71916,7 +75130,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71992,6 +75209,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72039,7 +75257,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; "webhook-user-created": { @@ -72049,7 +75267,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; "webhook-user-deleted": { @@ -72059,7 +75277,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** watch started event */ @@ -72070,7 +75288,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -72082,7 +75300,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -72093,7 +75311,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -72114,7 +75332,7 @@ export interface components { /** Format: uri */ html_url: string; id: number; - /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.10/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ + /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.14/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ labels: string[]; name: string; node_id: string; @@ -72198,7 +75416,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -72211,7 +75429,7 @@ export interface components { /** Format: uri */ html_url: string; id: number; - /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.10/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ + /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.14/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ labels: string[]; name: string; node_id: string; @@ -72296,7 +75514,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -72350,7 +75568,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -72409,7 +75627,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -72449,6 +75667,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -72468,6 +75687,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -72608,6 +75828,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -72782,6 +76003,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -72856,6 +76078,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -72879,7 +76102,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -73343,7 +76566,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -73383,6 +76606,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -73543,6 +76767,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -73717,6 +76942,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -73791,6 +77017,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -73804,18 +77031,18 @@ export interface components { }; }; responses: { - /** @description Resource not found */ - not_found: { - content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; + /** @description Resource not found */ + not_found: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Bad Request */ bad_request: { content: { @@ -73895,12 +77122,6 @@ export interface components { }; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ - code_scanning_forbidden_read: { - content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; /** @description Forbidden Gist */ forbidden_gist: { content: { @@ -73947,6 +77168,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response if GitHub Advanced Security is not enabled for this repository */ + code_scanning_forbidden_read: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { content: { @@ -74010,9 +77237,9 @@ export interface components { }; }; parameters: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "per-page"?: number; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @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; @@ -74032,6 +77259,12 @@ export interface components { "pre-receive-hook-id": number; /** @description The unique identifier of the token. */ "token-id": number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "pagination-before"?: string; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "pagination-after"?: string; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ + ghsa_id: string; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: string; "delivery-id": number; @@ -74060,7 +77293,7 @@ export interface components { "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; - /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: @@ -74072,9 +77305,9 @@ export interface components { * The default is `web`. */ "audit-log-include"?: "web" | "git" | "all"; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ "audit-log-after"?: string; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -74086,10 +77319,6 @@ 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 A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * @@ -74132,19 +77361,18 @@ export interface components { "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ + /** @description A comma-separated list of secret types to return. By default all secret types are returned. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ "secret-scanning-alert-sort"?: "created" | "updated"; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ + "secret-scanning-alert-validity"?: string; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" + | "advanced_security_user_namespace" | "dependabot_alerts" | "secret_scanning" | "secret_scanning_push_protection"; @@ -74161,6 +77389,8 @@ export interface components { "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: string; + /** @description Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint. */ + "license-apply"?: boolean; /** @description The UUID which identifies a node. */ uuid?: string; /** @description The cluster roles from the cluster configuration file. */ @@ -74175,7 +77405,7 @@ export interface components { participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: string; - /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ "since-org"?: number; @@ -74185,25 +77415,31 @@ export interface components { "visible-to-repository"?: string; /** @description The name of the secret. */ "secret-name": string; - /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "variables-per-page"?: number; /** @description The name of the variable. */ "variable-name": string; - /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ "audit-log-phrase"?: string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The unique identifier of the group. */ "group-id": number; + /** @description The number of results per page for the "members" array (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-per-page"?: number; + /** @description The page number of the "members" array results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-page"?: number; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ "repo-name": string; + /** @description The slug of the team name. */ + "team-slug": string; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ "package-visibility"?: "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ @@ -74232,12 +77468,39 @@ 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 A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/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. */ + /** @description The custom property name */ + "custom-property-name": string; + /** + * @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + */ + "ruleset-targets"?: string; + /** @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 name of the repository to filter on. */ + "repository-name-in-query"?: string; + /** + * @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-server@3.14/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.14/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-server@3.14/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-server@3.10/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. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/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. */ "secret-scanning-pagination-after-org-repo"?: string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -74289,7 +77552,7 @@ export interface components { actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ "workflow-run-branch"?: string; - /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.10/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ + /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.14/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ "workflow-run-status"?: @@ -74307,7 +77570,7 @@ export interface components { | "requested" | "waiting" | "pending"; - /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.10/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ + /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ "exclude-pull-requests"?: boolean; @@ -74323,7 +77586,7 @@ export interface components { "workflow-id": number | string; /** @description The unique identifier of the autolink. */ "autolink-id": number; - /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.10/graphql). */ + /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.14/graphql). */ branch: string; /** @description The unique identifier of the check run. */ "check-run-id": number; @@ -74375,6 +77638,8 @@ export interface components { "key-id": number; /** @description The number that identifies the milestone. */ "milestone-number": number; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ "pull-number": number; /** @description The unique identifier of the review. */ @@ -74409,6 +77674,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred"?: "created" | "updated"; + /** @description account_id parameter */ + "account-id": number; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user"?: number; }; @@ -74484,12 +77751,12 @@ export interface operations { url: string; /** @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. */ content_type?: string; - /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers) header. */ + /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers) header. */ secret?: string; /** @description Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** */ insecure_ssl?: string; }; - /** @description The [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ + /** @description The [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. @@ -74557,12 +77824,12 @@ export interface operations { url: string; /** @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. */ content_type?: string; - /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers) header. */ + /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers) header. */ secret?: string; /** @description Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** */ insecure_ssl?: string; }; - /** @description The [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ + /** @description The [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. @@ -74583,7 +77850,7 @@ export interface operations { }; /** * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the webhook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) to be sent to the webhook. */ "enterprise-admin/ping-global-webhook": { parameters: { @@ -74638,7 +77905,7 @@ export interface operations { }; /** * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. + * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ "enterprise-admin/update-ldap-mapping-for-team": { parameters: { @@ -75134,7 +78401,7 @@ export interface operations { }; /** * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * @@ -75149,7 +78416,7 @@ export interface operations { /** * @description **Required for built-in authentication.** The user's email * address. This parameter can be omitted when using CAS, LDAP, or SAML. - * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." + * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." */ email?: string; /** @@ -75171,7 +78438,7 @@ export interface operations { }; /** * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#suspend-a-user) is often a better option. + * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#suspend-a-user) is often a better option. * * You can delete any user account except your own. */ @@ -75225,7 +78492,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description A list of [scopes](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + /** @description A list of [scopes](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ scopes: string[]; }; }; @@ -75259,11 +78526,118 @@ export interface operations { }; }; }; + /** + * List global security advisories + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.14/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + */ + "security-advisories/list-global-advisories": { + parameters: { + query?: { + /** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */ + ghsa_id?: string; + /** @description If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. */ + type?: "reviewed" | "malware" | "unreviewed"; + /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ + cve_id?: string; + /** @description If specified, only advisories for these ecosystems will be returned. */ + ecosystem?: components["schemas"]["security-advisory-ecosystems"]; + /** @description If specified, only advisories with these severities will be returned. */ + severity?: "unknown" | "low" | "medium" | "high" | "critical"; + /** + * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + * + * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` + */ + cwes?: string | string[]; + /** @description Whether to only return advisories that have been withdrawn. */ + is_withdrawn?: boolean; + /** + * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + * + * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + */ + affects?: string | string[]; + /** + * @description If specified, only return advisories that were published on a date or date range. + * + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + */ + published?: string; + /** + * @description If specified, only return advisories that were updated on a date or date range. + * + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + */ + updated?: string; + /** + * @description If specified, only show advisories that were updated or published on a date or date range. + * + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.14/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + */ + modified?: string; + /** + * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description The property to sort the results by. */ + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["global-advisory"][]; + }; + }; + 422: components["responses"]["validation_failed_simple"]; + /** @description Too many requests */ + 429: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + /** + * Get a global security advisory + * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + */ + "security-advisories/get-global-advisory": { + parameters: { + path: { + ghsa_id: components["parameters"]["ghsa_id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["global-advisory"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-authenticated": { responses: { @@ -75277,7 +78651,7 @@ export interface operations { }; /** * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ "apps/create-from-manifest": { parameters: { @@ -75306,7 +78680,7 @@ export interface operations { * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-webhook-config-for-app": { responses: { @@ -75322,7 +78696,7 @@ export interface operations { * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/update-webhook-config-for-app": { requestBody: { @@ -75348,14 +78722,13 @@ export interface operations { * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/list-webhook-deliveries": { parameters: { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -75373,7 +78746,7 @@ export interface operations { * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-webhook-delivery": { parameters: { @@ -75396,7 +78769,7 @@ export interface operations { * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/redeliver-webhook-delivery": { parameters: { @@ -75877,7 +79250,7 @@ export interface operations { * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-installation": { parameters: { @@ -75897,9 +79270,9 @@ export interface operations { }; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/delete-installation": { parameters: { @@ -75925,7 +79298,7 @@ export interface operations { * * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/create-installation-access-token": { parameters: { @@ -75966,7 +79339,7 @@ export interface operations { * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/suspend-installation": { parameters: { @@ -75986,7 +79359,7 @@ export interface operations { * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/unsuspend-installation": { parameters: { @@ -76005,9 +79378,10 @@ export interface operations { /** * List your grants * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ "oauth-authorizations/list-grants": { parameters: { @@ -76037,7 +79411,8 @@ export interface operations { /** * Get a single grant * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ "oauth-authorizations/get-grant": { parameters: { @@ -76060,7 +79435,8 @@ export interface operations { /** * Delete a grant * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -76082,7 +79458,7 @@ export interface operations { }; /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ "apps/delete-authorization": { @@ -76109,7 +79485,7 @@ export interface operations { }; /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -76138,7 +79514,7 @@ export interface operations { }; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -76164,7 +79540,7 @@ export interface operations { }; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -76197,10 +79573,6 @@ export interface operations { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ "apps/scope-token": { parameters: { @@ -76254,7 +79626,8 @@ export interface operations { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ "apps/get-by-slug": { parameters: { @@ -76276,7 +79649,8 @@ export interface operations { /** * List your authorizations * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ "oauth-authorizations/list-authorizations": { parameters: { @@ -76306,17 +79680,19 @@ export interface operations { /** * Create a new authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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). * - * Creates 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)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * - * 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). + * 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.14/articles/creating-an-access-token-for-command-line-use). * - * 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. + * 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.14/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?: { @@ -76367,15 +79743,15 @@ export interface operations { /** * Get-or-create an authorization for a specific app * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." - * - * **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/). + * 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ "oauth-authorizations/get-or-create-authorization-for-app": { parameters: { @@ -76419,7 +79795,10 @@ export interface operations { "application/json": components["schemas"]["authorization"]; }; }; - /** @description **Deprecation Notice:** GitHub 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/apps/building-oauth-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/). */ + /** + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). + */ 201: { headers: { /** @example https://api.github.com/authorizations/1 */ @@ -76438,13 +79817,15 @@ export interface operations { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." + * 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { parameters: { @@ -76503,7 +79884,8 @@ export interface operations { /** * Get a single authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ "oauth-authorizations/get-authorization": { parameters: { @@ -76526,7 +79908,8 @@ export interface operations { /** * Delete an authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). */ "oauth-authorizations/delete-authorization": { parameters: { @@ -76547,9 +79930,10 @@ export interface operations { /** * Update an existing authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/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/). * - * 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)." + * 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.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * You can only send one of these scope keys at a time. */ @@ -77107,7 +80491,7 @@ export interface operations { * Get default workflow permissions for an enterprise * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -77130,7 +80514,7 @@ export interface operations { * Set default workflow permissions for an enterprise * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets * whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -77531,6 +80915,8 @@ export interface operations { "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { query?: { + /** @description The name of a self-hosted runner. */ + name?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; }; @@ -77861,7 +81247,7 @@ export interface operations { }; /** * List code scanning alerts for an enterprise - * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be a member of the enterprise to use this endpoint. * @@ -77906,7 +81292,7 @@ export interface operations { * * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ "secret-scanning/get-security-analysis-settings-for-enterprise": { parameters: { @@ -77941,16 +81327,18 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.10/get-started/learning-about-github/about-github-advanced-security)." */ + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.14/get-started/learning-about-github/about-github-advanced-security)." */ advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.10/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." */ + /** @description Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.14/get-started/learning-about-github/about-github-advanced-security)." */ + advanced_security_enabled_new_user_namespace_repos?: boolean; + /** @description Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/about-secret-scanning)." */ + /** @description Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning)." */ secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ + /** @description Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** - * @description The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * @description The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; @@ -77975,7 +81363,7 @@ export interface operations { * * The authenticated user must be a member of the enterprise to use this endpoint. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ @@ -78015,7 +81403,7 @@ export interface operations { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. */ "secret-scanning/list-alerts-for-enterprise": { parameters: { @@ -78028,6 +81416,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { enterprise: components["parameters"]["enterprise"]; @@ -78072,7 +81461,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -78105,7 +81493,8 @@ export interface operations { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-public-events": { parameters: { @@ -78131,16 +81520,17 @@ export interface operations { * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -78182,7 +81572,8 @@ export interface operations { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ "gists/create": { requestBody: { @@ -78232,7 +81623,7 @@ export interface operations { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ "gists/list-public": { parameters: { @@ -78288,7 +81679,7 @@ export interface operations { * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -78384,7 +81775,7 @@ export interface operations { * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -78418,7 +81809,7 @@ export interface operations { * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -78460,7 +81851,7 @@ export interface operations { * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -78506,7 +81897,7 @@ export interface operations { * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -78640,7 +82031,7 @@ export interface operations { }; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "gists/star": { parameters: { @@ -78679,7 +82070,7 @@ export interface operations { * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -78705,7 +82096,7 @@ export interface operations { }; /** * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-for-the-authenticated-user). + * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ "gitignore/get-all-templates": { responses: { @@ -78722,7 +82113,7 @@ export interface operations { * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ @@ -78777,7 +82168,7 @@ export interface operations { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ "apps/revoke-installation-access-token": { responses: { @@ -78793,12 +82184,10 @@ export interface operations { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -78848,7 +82237,7 @@ export interface operations { }; /** * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ "licenses/get-all-commonly-used": { parameters: { @@ -78870,7 +82259,7 @@ export interface operations { }; /** * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ "licenses/get": { parameters: { @@ -78890,9 +82279,382 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get the configured SSH keys + * @description Gets the configured SSH keys on all available nodes. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/get-manage-ssh": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-ssh"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Set a new SSH key + * @description Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/set-manage-ssh": { + requestBody: { + content: { + "application/json": components["schemas"]["ghes-set-ssh-request"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-set-ssh-response"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Delete a SSH key + * @description Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/delete-manage-ssh": { + requestBody: { + content: { + "application/json": components["schemas"]["ghes-delete-ssh-request"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-delete-ssh-response"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the system requirement check results for configured cluster nodes + * @description Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + * This endpoint may take several seconds to reply. + */ + "enterprise-admin/get-checks-system-requirements": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-checks-system-requirements"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. + */ + "enterprise-admin/get-cluster-status": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-cluster-status"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + "enterprise-admin/get-manage-config-apply-status": { + parameters: { + query?: { + /** @description The unique run ID of the `ghe-config-apply` run. */ + run_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Whether the ghe-config-apply run is still running in the environment */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful in the environment */ + successful?: boolean; + nodes?: { + /** @description The unique Run ID of the ghe-config-apply run on the host */ + run_id?: string; + /** @description The hostname of the node */ + hostname?: string; + /** @description Whether the ghe-config-apply run is still running on the host */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful on the host */ + successful?: boolean; + }[]; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + "enterprise-admin/post-manage-run-config-apply": { + requestBody?: { + content: { + "application/json": { + /** @description The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly. */ + run_id?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Run ID the job was launched with */ + run_id?: string; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + "enterprise-admin/get-manage-config-apply-events": { + parameters: { + query?: { + /** @description The unique ID of the last response from a host, used for pagination. */ + last_request_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + nodes?: { + /** @description Hostname of the node */ + node?: string; + /** @description Unique ID of the last response from a host used for pagination */ + last_request_id?: string; + events?: { + timestamp?: string; + severity_text?: string; + body?: string; + event_name?: string; + topology?: string; + hostname?: string; + config_run_id?: string; + trace_id?: string; + span_id?: string; + span_parent_id?: string; + span_depth?: number; + }[]; + }[]; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + * + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + * + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + "enterprise-admin/initialize-instance-configuration": { + requestBody: { + content: { + "multipart/form-data": components["schemas"]["ghes-config-init-request"]; + }; + }; + responses: { + /** @description Response */ + 202: { + content: never; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the enterprise license information + * @description Gets information about the license that is currently set for the enterprise. + */ + "enterprise-admin/license-info": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-license-info"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Upload an enterprise license + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + "enterprise-admin/license-upload": { + parameters: { + query?: { + apply?: components["parameters"]["license-apply"]; + }; + }; + requestBody: { + content: { + "multipart/form-data": components["schemas"]["ghes-upload-license-request"]; + }; + }; + responses: { + /** @description Created */ + 201: { + content: never; + }; + /** @description Accepted */ + 202: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Check a license + * @description Check the status of the license that is currently set for the enterprise. + */ + "enterprise-admin/license-check": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-license-check"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; /** * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.10/admin/enterprise-management/configuring-clustering/about-clustering)." + * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.14/admin/enterprise-management/configuring-clustering/about-clustering)." */ "enterprise-admin/get-config-nodes": { parameters: { @@ -78918,9 +82680,65 @@ export interface operations { }; }; }; + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + "enterprise-admin/get-manage-settings": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-settings"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Set settings + * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-settings). + * + * **Notes:** + * - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + * - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + */ + "enterprise-admin/set-manage-settings": { + /** @description Only the settings parameters that should be modified need to be specified. */ + requestBody: { + content: { + "application/json": Record; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; /** * Get the status of maintenance mode - * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ "enterprise-admin/get-manage-maintenance": { parameters: { @@ -78952,7 +82770,7 @@ export interface operations { }; /** * Set the status of maintenance mode - * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ "enterprise-admin/set-manage-maintenance": { requestBody: { @@ -79012,7 +82830,7 @@ export interface operations { }; /** * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.10/admin/all-releases)." + * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.14/admin/all-releases)." */ "enterprise-admin/get-version": { parameters: { @@ -79109,7 +82927,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-repo-network": { parameters: { query?: { @@ -79146,7 +82968,7 @@ export interface operations { since?: components["parameters"]["since"]; before?: components["parameters"]["before"]; page?: components["parameters"]["page"]; - /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; }; @@ -79168,7 +82990,7 @@ export interface operations { }; /** * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ "activity/mark-notifications-as-read": { requestBody?: { @@ -79224,6 +83046,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications. + */ + "activity/mark-thread-as-done": { + parameters: { + path: { + thread_id: components["parameters"]["thread-id"]; + }; + }; + responses: { + /** @description No content */ + 204: { + content: never; + }; + }; + }; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. @@ -79245,7 +83084,7 @@ export interface operations { }; /** * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#get-a-repository-subscription). + * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ @@ -79273,7 +83112,7 @@ export interface operations { * * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ "activity/set-thread-subscription": { parameters: { @@ -79306,7 +83145,7 @@ export interface operations { }; /** * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ "activity/delete-thread-subscription": { parameters: { @@ -79348,7 +83187,8 @@ export interface operations { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ "orgs/list": { parameters: { @@ -79372,12 +83212,12 @@ export interface operations { }; }; /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * @@ -79410,21 +83250,10 @@ export interface operations { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.14/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -79453,7 +83282,7 @@ export interface operations { * * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.10/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.14/site-policy/github-terms/github-terms-of-service */ "orgs/delete": { parameters: { @@ -79469,20 +83298,13 @@ export interface operations { }; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version. * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -79526,15 +83348,15 @@ export interface operations { * @default true */ members_can_create_repositories?: boolean; - /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_internal_repositories?: boolean; - /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_private_repositories?: boolean; - /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -79556,49 +83378,67 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. + * + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. + * + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ @@ -79933,7 +83773,7 @@ export interface operations { * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -79956,7 +83796,7 @@ export interface operations { * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -80363,6 +84203,8 @@ export interface operations { "actions/list-self-hosted-runners-for-org": { parameters: { query?: { + /** @description The name of a self-hosted runner. */ + name?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; }; @@ -80930,7 +84772,7 @@ export interface operations { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -80946,7 +84788,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -80962,7 +84804,7 @@ export interface operations { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -80991,7 +84833,7 @@ export interface operations { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -81367,11 +85209,11 @@ export interface operations { }; /** * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -81403,7 +85245,7 @@ export interface operations { }; /** * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an owner or security manager for the organization to use this endpoint. * @@ -81446,7 +85288,7 @@ export interface operations { }; /** * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -81476,7 +85318,7 @@ export interface operations { }; /** * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -81506,7 +85348,7 @@ export interface operations { }; /** * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -81532,7 +85374,7 @@ export interface operations { /** * Delete a custom repository role * @description Deletes a custom role from an organization. Once the custom role has been deleted, any - * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -81554,7 +85396,7 @@ export interface operations { }; /** * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -81870,7 +85712,7 @@ export interface operations { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -81884,7 +85726,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -81900,7 +85742,7 @@ export interface operations { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -81927,7 +85769,7 @@ export interface operations { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -81973,7 +85815,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-org-events": { parameters: { query?: { @@ -81997,10 +85843,14 @@ export interface operations { * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/external-idp-group-info-for-org": { parameters: { + query?: { + per_page?: components["parameters"]["members-per-page"]; + page?: components["parameters"]["members-page"]; + }; path: { org: components["parameters"]["org"]; group_id: components["parameters"]["group-id"]; @@ -82019,7 +85869,7 @@ export interface operations { * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/list-external-idp-groups-for-org": { parameters: { @@ -82049,7 +85899,9 @@ export interface operations { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -82109,7 +85961,7 @@ export interface operations { password?: string; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ * "push" * ] @@ -82167,7 +86019,9 @@ export interface operations { }; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -82218,7 +86072,7 @@ export interface operations { insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for. * @default [ * "push" * ] @@ -82319,7 +86173,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -82390,7 +86243,7 @@ export interface operations { }; /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) * to be sent to the hook. * * You must be an organization owner to use this endpoint. @@ -82417,7 +86270,7 @@ export interface operations { * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-org-installation": { parameters: { @@ -82472,12 +86325,10 @@ export interface operations { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -82628,13 +86479,13 @@ export interface operations { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.14/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ "orgs/set-membership-for-user": { parameters: { @@ -82724,7 +86575,7 @@ 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)." + * 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.14/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: { @@ -82870,7 +86721,7 @@ export interface operations { }; /** * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ "migrations/unlock-repo-for-org": { parameters: { @@ -82916,6 +86767,424 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-organization-fine-grained-permissions": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-org-roles": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response - list of organization roles */ + 200: { + content: { + "application/json": { + /** @description The total number of organization roles available to the organization. */ + total_count?: number; + /** @description The list of organization roles available to the organization. */ + roles?: components["schemas"]["organization-role"][]; + }; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific + * permissions over the organization and optionally across all repositories in the organization. For + * more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/create-custom-organization-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-custom-organization-role-create-schema"]; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Remove all organization roles for a team + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-all-org-roles-team": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/assign-team-to-org-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + /** @description Response if the organization, team or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ + 422: { + content: never; + }; + }; + }; + /** + * Remove an organization role from a team + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-org-role-team": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-all-org-roles-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/assign-user-to-org-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + /** @description Response if the organization, user or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ + 422: { + content: never; + }; + }; + }; + /** + * Remove an organization role from a user + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-org-role-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/get-org-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/delete-custom-organization-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/patch-custom-organization-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-custom-organization-role-update-schema"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * List teams that are assigned to an organization role + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-org-role-teams": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response - List of assigned teams */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["team-role-assignment"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + content: never; + }; + }; + }; + /** + * List users that are assigned to an organization role + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-org-role-users": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response - List of assigned users */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["user-role-assignment"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + content: never; + }; + }; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. @@ -82946,7 +87215,7 @@ export interface operations { }; /** * Convert an organization member to outside collaborator - * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.10/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.14/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ "orgs/convert-member-to-outside-collaborator": { parameters: { @@ -82977,7 +87246,7 @@ export interface operations { 204: { content: never; }; - /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ + /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ 403: { content: never; }; @@ -83015,7 +87284,7 @@ export interface operations { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-organization": { parameters: { @@ -83029,9 +87298,9 @@ export interface operations { | "nuget" | "container"; visibility?: components["parameters"]["package-visibility"]; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; path: { @@ -83054,7 +87323,7 @@ export interface operations { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-organization": { parameters: { @@ -83077,9 +87346,9 @@ export interface operations { * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-org": { parameters: { @@ -83107,9 +87376,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-org": { parameters: { @@ -83137,7 +87406,7 @@ export interface operations { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { @@ -83169,7 +87438,7 @@ export interface operations { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-organization": { parameters: { @@ -83193,9 +87462,9 @@ export interface operations { * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-org": { parameters: { @@ -83224,9 +87493,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-org": { parameters: { @@ -83682,6 +87951,206 @@ 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. + * Organization members can read these properties. + */ + "orgs/get-all-custom-properties": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "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"]["custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * Organization members can read these properties. + */ + "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"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "orgs/create-or-update-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["custom-property-set-payload"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "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"]; + /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.14/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + repository_query?: string; + }; + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + */ + "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 No Content when custom property values are successfully created or updated */ + 204: { + content: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. @@ -83734,7 +88203,7 @@ export interface operations { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "orgs/set-public-membership-for-authenticated-user": { parameters: { @@ -83773,7 +88242,8 @@ export interface operations { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/list-for-org": { parameters: { @@ -83837,7 +88307,7 @@ export interface operations { */ private?: boolean; /** - * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.10/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.14/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. * @enum {string} */ @@ -83877,7 +88347,7 @@ export interface operations { auto_init?: boolean; /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ gitignore_template?: string; - /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.10/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ + /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.14/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ license_template?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. @@ -83906,12 +88376,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -83928,7 +88400,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -83944,6 +88418,10 @@ export interface operations { * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; }; }; @@ -83964,7 +88442,7 @@ export interface operations { }; /** * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -83985,6 +88463,223 @@ export interface operations { }; }; }; + /** + * Get all organization repository rulesets + * @description Get all the repository rulesets for an organization. + */ + "repos/get-org-rulesets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Create an organization repository ruleset + * @description Create a repository ruleset for an organization. + */ + "repos/create-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + /** @description Request body */ + requestBody: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name: string; + /** + * @description The target of the ruleset. + * @default branch + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + /** + * @description The type of the source of the ruleset + * @enum {string} + */ + source_type?: "Repository" | "Organization"; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 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-server@3.14/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + "repos/get-org-rule-suites": { + parameters: { + query?: { + ref?: components["parameters"]["ref-in-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-server@3.14/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. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + "repos/get-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Update an organization repository ruleset + * @description Update a ruleset for an organization. + */ + "repos/update-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + /** @description Request body */ + requestBody?: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name?: string; + /** + * @description The target of the ruleset. + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Delete an organization repository ruleset + * @description Delete a ruleset for an organization. + */ + "repos/delete-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. @@ -84005,6 +88700,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { org: components["parameters"]["org"]; @@ -84026,7 +88722,7 @@ export interface operations { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * @@ -84049,7 +88745,7 @@ export interface operations { }; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -84067,15 +88763,11 @@ export interface operations { 204: { content: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - content: never; - }; }; }; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -84122,7 +88814,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -84154,9 +88845,9 @@ export interface operations { }; /** * Create a team - * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.10/articles/setting-team-creation-permissions-in-your-organization)." + * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.14/articles/setting-team-creation-permissions-in-your-organization)." * - * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ "teams/create": { parameters: { @@ -84198,14 +88889,14 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ permission?: "pull" | "push"; /** @description The ID of a team to set as the parent team. */ parent_team_id?: number; - /** @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the "[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" endpoint to change the LDAP DN. For more information, see "[Using LDAP](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." */ + /** @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the "[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" endpoint to change the LDAP DN. For more information, see "[Using LDAP](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." */ ldap_dn?: string; }; }; @@ -84225,7 +88916,8 @@ export interface operations { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ "teams/get-by-name": { parameters: { @@ -84250,7 +88942,8 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ "teams/delete-in-org": { parameters: { @@ -84270,7 +88963,8 @@ export interface operations { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ "teams/update-in-org": { parameters: { @@ -84306,7 +89000,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -84338,7 +89032,8 @@ export interface operations { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -84372,9 +89067,10 @@ export interface operations { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84413,7 +89109,8 @@ export interface operations { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -84438,7 +89135,8 @@ export interface operations { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84461,7 +89159,8 @@ export interface operations { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84496,7 +89195,8 @@ export interface operations { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -84529,9 +89229,10 @@ export interface operations { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84564,7 +89265,8 @@ export interface operations { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -84590,7 +89292,8 @@ export interface operations { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84614,7 +89317,8 @@ export interface operations { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84646,16 +89350,17 @@ export interface operations { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: | "+1" | "-1" @@ -84689,11 +89394,12 @@ export interface operations { }; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84710,7 +89416,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: @@ -84742,9 +89448,10 @@ export interface operations { }; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84767,16 +89474,17 @@ export interface operations { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: | "+1" | "-1" @@ -84809,11 +89517,12 @@ export interface operations { }; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84829,7 +89538,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: @@ -84861,9 +89570,10 @@ export interface operations { }; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -84887,7 +89597,7 @@ export interface operations { * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/list-linked-external-idp-groups-to-team-for-org": { parameters: { @@ -84909,7 +89619,7 @@ export interface operations { * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { @@ -84929,7 +89639,7 @@ export interface operations { * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/link-external-idp-group-to-team-for-org": { parameters: { @@ -84995,12 +89705,13 @@ export interface operations { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team). */ "teams/get-membership-for-user-in-org": { parameters: { @@ -85027,15 +89738,17 @@ export interface operations { * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -85078,11 +89791,13 @@ export interface operations { * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -85107,7 +89822,8 @@ export interface operations { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ "teams/list-projects-in-org": { parameters: { @@ -85136,7 +89852,8 @@ export interface operations { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -85163,7 +89880,8 @@ export interface operations { * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -85177,7 +89895,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -85204,7 +89922,8 @@ export interface operations { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/remove-project-in-org": { parameters: { @@ -85225,7 +89944,8 @@ export interface operations { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ "teams/list-repos-in-org": { parameters: { @@ -85254,13 +89974,14 @@ export interface operations { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/check-permissions-for-repo-in-org": { parameters: { @@ -85290,11 +90011,12 @@ export interface operations { }; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * - * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ "teams/add-or-update-repo-permissions-in-org": { parameters: { @@ -85308,10 +90030,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -85327,7 +90046,8 @@ export interface operations { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/remove-repo-in-org": { parameters: { @@ -85349,7 +90069,8 @@ export interface operations { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ "teams/list-child-in-org": { parameters: { @@ -85376,11 +90097,15 @@ export interface operations { }; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -85390,6 +90115,18 @@ export interface operations { enablement: components["parameters"]["org-security-product-enablement"]; }; }; + requestBody?: { + content: { + "application/json": { + /** + * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @enum {string} + */ + query_suite?: "default" | "extended"; + }; + }; + }; responses: { /** @description Action started */ 204: { @@ -86058,20 +90795,22 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.10/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.10/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.10/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.10/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.14/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.14/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.14/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.14/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.14/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.14/rest/about-the-rest-api/api-versions)." + * + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { responses: { @@ -86094,7 +90833,8 @@ export interface operations { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/get": { parameters: { @@ -86151,7 +90891,7 @@ export interface operations { }; /** * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#replace-all-repository-topics) endpoint. + * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics) endpoint. */ "repos/update": { parameters: { @@ -86171,7 +90911,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.14/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -86183,7 +90923,7 @@ export interface operations { /** * @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. @@ -86256,12 +90996,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -86278,7 +91020,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -86856,8 +91600,8 @@ export interface operations { * Get the level of access for workflows outside of the repository * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -86881,8 +91625,8 @@ export interface operations { * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -86960,7 +91704,7 @@ export interface operations { * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -86984,7 +91728,7 @@ export interface operations { * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -87022,6 +91766,8 @@ export interface operations { "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { + /** @description The name of a self-hosted runner. */ + name?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; }; @@ -87348,13 +92094,13 @@ export interface operations { }; /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs-for-repo": { parameters: { @@ -87532,7 +92278,7 @@ export interface operations { /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -87622,10 +92368,10 @@ export interface operations { }; /** * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -87651,10 +92397,35 @@ 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). + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope 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. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -87971,7 +92742,7 @@ export interface operations { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -87988,7 +92759,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -88319,11 +93090,13 @@ export interface operations { }; /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs": { parameters: { @@ -88360,9 +93133,68 @@ export interface operations { }; }; }; + /** + * 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. + * + * For more information about viewing repository activity, + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.14/repositories/viewing-activity-and-data-for-your-repository)." + */ + "repos/list-activities": { + parameters: { + query?: { + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description The Git reference for the activities you want to list. + * + * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. + */ + ref?: string; + /** @description The GitHub username to use to filter by the actor who performed the activity. */ + actor?: string; + /** + * @description The time period to filter by. + * + * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). + */ + time_period?: "day" | "week" | "month" | "quarter" | "year"; + /** + * @description The activity type to filter by. + * + * For example, you can choose to filter by "force_push", to see all force pushes to the repository. + */ + activity_type?: + | "push" + | "force_push" + | "branch_creation" + | "branch_deletion" + | "pr_merge" + | "merge_queue_merge"; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["activity"][]; + }; + }; + 422: components["responses"]["validation_failed_simple"]; + }; + }; /** * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.10/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.14/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ "issues/list-assignees": { parameters: { @@ -88527,7 +93359,7 @@ export interface operations { }; /** * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.10/articles/configuring-automated-security-fixes)". + * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.14/articles/configuring-automated-security-fixes)". */ "repos/check-automated-security-fixes": { parameters: { @@ -88537,13 +93369,13 @@ export interface operations { }; }; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { content: never; }; @@ -88553,7 +93385,7 @@ export interface operations { "repos/list-branches": { parameters: { query?: { - /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -88598,7 +93430,7 @@ export interface operations { }; /** * Get branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-branch-protection": { parameters: { @@ -88620,13 +93452,15 @@ export interface operations { }; /** * Update branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ "repos/update-branch-protection": { parameters: { @@ -88645,7 +93479,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -88671,7 +93505,7 @@ export interface operations { }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ dismiss_stale_reviews?: boolean; - /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.10/articles/about-code-owners/) review them. */ + /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.14/articles/about-code-owners/) review them. */ require_code_owner_reviews?: boolean; /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ required_approving_review_count?: number; @@ -88699,11 +93533,11 @@ export interface operations { /** @description The list of app `slug`s with push access */ apps?: string[]; } | null; - /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ + /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ allow_force_pushes?: boolean | null; - /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ + /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ allow_deletions?: boolean; /** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */ block_creations?: boolean; @@ -88736,7 +93570,7 @@ export interface operations { }; /** * Delete branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/delete-branch-protection": { parameters: { @@ -88756,7 +93590,7 @@ export interface operations { }; /** * Get admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-admin-branch-protection": { parameters: { @@ -88777,7 +93611,7 @@ export interface operations { }; /** * Set admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -88800,7 +93634,7 @@ export interface operations { }; /** * Delete admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -88822,7 +93656,7 @@ export interface operations { }; /** * Get pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-pull-request-review-protection": { parameters: { @@ -88843,7 +93677,7 @@ export interface operations { }; /** * Delete pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/delete-pull-request-review-protection": { parameters: { @@ -88863,11 +93697,12 @@ export interface operations { }; /** * Update pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ "repos/update-pull-request-review-protection": { parameters: { @@ -88891,7 +93726,7 @@ export interface operations { }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ dismiss_stale_reviews?: boolean; - /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.10/articles/about-code-owners/) have reviewed. */ + /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.14/articles/about-code-owners/) have reviewed. */ require_code_owner_reviews?: boolean; /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ required_approving_review_count?: number; @@ -88924,11 +93759,12 @@ export interface operations { }; /** * Get commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.10/articles/signing-commits-with-gpg) in GitHub Help. + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.14/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ "repos/get-commit-signature-protection": { parameters: { @@ -88950,7 +93786,7 @@ export interface operations { }; /** * Create commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -88974,7 +93810,7 @@ export interface operations { }; /** * Delete commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -88996,7 +93832,7 @@ export interface operations { }; /** * Get status checks protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-status-checks-protection": { parameters: { @@ -89018,7 +93854,7 @@ export interface operations { }; /** * Remove status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/remove-status-check-protection": { parameters: { @@ -89037,7 +93873,7 @@ export interface operations { }; /** * Update status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -89056,7 +93892,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -89082,7 +93918,7 @@ export interface operations { }; /** * Get all status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-all-status-check-contexts": { parameters: { @@ -89104,7 +93940,7 @@ export interface operations { }; /** * Set status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/set-status-check-contexts": { parameters: { @@ -89135,7 +93971,7 @@ export interface operations { }; /** * Add status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/add-status-check-contexts": { parameters: { @@ -89167,7 +94003,7 @@ export interface operations { }; /** * Remove status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/remove-status-check-contexts": { parameters: { @@ -89198,11 +94034,12 @@ export interface operations { }; /** * Get access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ "repos/get-access-restrictions": { parameters: { @@ -89224,7 +94061,7 @@ export interface operations { }; /** * Delete access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -89245,7 +94082,7 @@ export interface operations { }; /** * Get apps with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -89269,7 +94106,7 @@ export interface operations { }; /** * Set app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -89281,7 +94118,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -89301,7 +94138,7 @@ export interface operations { }; /** * Add app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -89313,7 +94150,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -89333,7 +94170,7 @@ export interface operations { }; /** * Remove app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -89345,7 +94182,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -89365,7 +94202,7 @@ export interface operations { }; /** * Get teams with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ @@ -89389,7 +94226,7 @@ export interface operations { }; /** * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ @@ -89421,7 +94258,7 @@ export interface operations { }; /** * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ @@ -89453,7 +94290,7 @@ export interface operations { }; /** * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ @@ -89485,7 +94322,7 @@ export interface operations { }; /** * Get users with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ @@ -89509,7 +94346,7 @@ export interface operations { }; /** * Set user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -89525,7 +94362,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -89545,7 +94382,7 @@ export interface operations { }; /** * Add user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -89561,7 +94398,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -89581,7 +94418,7 @@ export interface operations { }; /** * Remove user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -89597,7 +94434,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -89619,7 +94456,8 @@ export interface operations { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.10/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.14/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -89776,7 +94614,8 @@ export interface operations { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -89801,7 +94640,8 @@ export interface operations { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -89865,7 +94705,7 @@ export interface operations { summary: string; /** @description Can contain Markdown. */ text?: string; - /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.10/articles/about-status-checks#checks)". */ + /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.14/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.14/articles/about-status-checks#checks)". */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ path: string; @@ -89899,7 +94739,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.10/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.14/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -89963,9 +94803,9 @@ export interface operations { }; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -90001,9 +94841,10 @@ export interface operations { }; /** * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites)". + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.14/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -90039,7 +94880,7 @@ export interface operations { }; /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#create-a-check-suite). + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ "checks/set-suites-preferences": { @@ -90078,7 +94919,8 @@ export interface operations { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -90103,7 +94945,8 @@ export interface operations { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -90140,7 +94983,7 @@ export interface operations { }; /** * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -90310,8 +95153,8 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -90361,7 +95204,7 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * @@ -90548,7 +95391,7 @@ export interface operations { }; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -90561,7 +95404,7 @@ export interface operations { * ``` * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.14/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -90580,6 +95423,8 @@ export interface operations { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -90666,7 +95511,7 @@ export interface operations { * file. * * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * see "[About code owners](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ "repos/codeowners-errors": { parameters: { @@ -90762,17 +95607,17 @@ export interface operations { }; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Updating an existing collaborator's permission level** * @@ -90829,11 +95674,12 @@ export interface operations { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ "repos/remove-collaborator": { parameters: { @@ -90884,7 +95730,7 @@ export interface operations { * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -90918,7 +95764,7 @@ export interface operations { * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -90964,7 +95810,7 @@ export interface operations { * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -90999,12 +95845,12 @@ export interface operations { }; /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). + * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment). */ "reactions/list-for-commit-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ content?: | "+1" | "-1" @@ -91038,7 +95884,7 @@ export interface operations { }; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ "reactions/create-for-commit-comment": { parameters: { @@ -91052,7 +95898,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the commit comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the commit comment. * @enum {string} */ content: @@ -91085,9 +95931,10 @@ export interface operations { }; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.14/rest/commits/comments#get-a-commit-comment). */ "reactions/delete-for-commit-comment": { parameters: { @@ -91117,6 +95964,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -91147,8 +95995,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - since?: components["parameters"]["since"]; - /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -91176,7 +96025,7 @@ export interface operations { }; /** * List branches for HEAD commit - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -91203,7 +96052,7 @@ export interface operations { * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -91238,9 +96087,9 @@ export interface operations { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -91264,7 +96113,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -91319,9 +96168,10 @@ export interface operations { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -91337,6 +96187,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -91386,9 +96237,10 @@ export interface operations { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. + * 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.14/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.14/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -91428,7 +96280,8 @@ export interface operations { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -91531,11 +96384,11 @@ export interface operations { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.14/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.diff`**: Returns the diff of the commit. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -91548,10 +96401,10 @@ export interface operations { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api)." * * **Signature verification object** * @@ -91563,6 +96416,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -91611,7 +96465,7 @@ export interface operations { * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -91625,9 +96479,9 @@ export interface operations { * * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree). * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.14/rest/git/trees#get-a-tree). * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. * - If the requested file's size is: * - 1 MB or smaller: All features of this endpoint are supported. @@ -91661,6 +96515,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -91669,7 +96524,8 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.14/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -91728,7 +96584,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -91742,7 +96605,8 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.14/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -91846,12 +96710,12 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** * @deprecated - * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; before?: components["parameters"]["pagination-before"]; @@ -91904,7 +96768,7 @@ export interface operations { }; /** * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -92037,7 +96901,7 @@ export interface operations { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -92052,7 +96916,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -92237,7 +97101,7 @@ export interface operations { * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) for every submitted context must be in a `success` + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.14/rest/commits/statuses) for every submitted context must be in a `success` * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do * not require any contexts or create any commit statuses, the deployment will always succeed. @@ -92294,7 +97158,7 @@ export interface operations { * @default true */ auto_merge?: boolean; - /** @description The [status](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ + /** @description The [status](https://docs.github.com/enterprise-server@3.14/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; payload?: OneOf< [ @@ -92374,7 +97238,7 @@ export interface operations { * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * * Mark the active deployment as inactive by adding any non-successful deployment status. * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.14/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.14/rest/deployments/statuses#create-a-deployment-status)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ @@ -92454,7 +97318,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -92519,7 +97386,7 @@ export interface operations { }; /** * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#repository_dispatch)." + * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#repository_dispatch)." * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * @@ -92539,7 +97406,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -92592,7 +97459,8 @@ export interface operations { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -92619,9 +97487,11 @@ export interface operations { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -92637,6 +97507,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?: | { @@ -92724,7 +97595,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -92760,7 +97631,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. * @@ -92786,7 +97657,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -92815,7 +97686,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -92837,9 +97708,9 @@ export interface operations { }; /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -92873,7 +97744,7 @@ export interface operations { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -92904,11 +97775,13 @@ export interface operations { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app)". * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -92942,9 +97815,9 @@ export interface operations { }; /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -93081,7 +97954,7 @@ export interface operations { /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -93099,7 +97972,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#get-an-environment-public-key) endpoint. */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -93299,7 +98172,8 @@ export interface operations { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-repo-events": { parameters: { @@ -93352,9 +98226,11 @@ export interface operations { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ "repos/create-fork": { parameters: { @@ -93423,14 +98299,21 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw blob data. * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -93472,6 +98355,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -93505,7 +98389,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -93568,6 +98452,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -93612,7 +98497,8 @@ export interface operations { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -93641,7 +98527,8 @@ export interface operations { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ "git/get-ref": { parameters: { @@ -93757,7 +98644,7 @@ export interface operations { }; /** * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.14/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * * **Signature verification object** * @@ -93769,6 +98656,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -93851,6 +98739,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -93893,7 +98782,7 @@ export interface operations { * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.10/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.10/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.14/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.14/rest/git/refs#update-a-reference)." * * Returns an error if you try to delete a file that does not exist. */ @@ -93965,8 +98854,8 @@ export interface operations { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ "git/get-tree": { parameters: { @@ -94046,7 +98935,7 @@ export interface operations { insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for. * @default [ * "push" * ] @@ -94098,7 +98987,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -94132,7 +99026,7 @@ export interface operations { "application/json": { config?: components["schemas"]["webhook-config"]; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ * "push" * ] @@ -94226,7 +99120,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -94290,7 +99183,7 @@ export interface operations { }; /** * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) to be sent to the hook. */ "repos/ping-webhook": { parameters: { @@ -94312,7 +99205,8 @@ export interface operations { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ "repos/test-push-webhook": { parameters: { @@ -94334,7 +99228,7 @@ export interface operations { * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-repo-installation": { parameters: { @@ -94430,12 +99324,10 @@ export interface operations { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94485,12 +99377,12 @@ export interface operations { }; /** * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.10/articles/disabling-issues/), the API returns a `410 Gone` status. + * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.14/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94511,7 +99403,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: string | number | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -94556,7 +99448,7 @@ export interface operations { * * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94596,7 +99488,7 @@ export interface operations { * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94644,7 +99536,7 @@ export interface operations { * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94679,12 +99571,12 @@ export interface operations { }; /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). + * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment). */ "reactions/list-for-issue-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ content?: | "+1" | "-1" @@ -94718,7 +99610,7 @@ export interface operations { }; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ "reactions/create-for-issue-comment": { parameters: { @@ -94732,7 +99624,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the issue comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the issue comment. * @enum {string} */ content: @@ -94765,9 +99657,10 @@ export interface operations { }; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#get-an-issue-comment). */ "reactions/delete-for-issue-comment": { parameters: { @@ -94839,19 +99732,17 @@ export interface operations { }; /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.10/articles/transferring-an-issue-to-another-repository/) to another repository. If + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + * [transferred](https://docs.github.com/enterprise-server@3.14/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - * to the [`issues`](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#issues) webhook. + * to the [`issues`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94881,9 +99772,9 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -94905,7 +99796,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -95045,7 +99936,7 @@ export interface operations { * * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95083,12 +99974,12 @@ export interface operations { * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95205,7 +100096,7 @@ export interface operations { "application/json": OneOf< [ { - /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.10/rest/issues/labels#add-labels-to-an-issue)." */ + /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.14/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; }, { @@ -95247,7 +100138,7 @@ export interface operations { "application/json": OneOf< [ { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.10/rest/issues/labels#set-labels-for-an-issue)." */ + /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; }, { @@ -95323,7 +100214,7 @@ export interface operations { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "issues/lock": { parameters: { @@ -95382,12 +100273,12 @@ export interface operations { }; /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). + * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). */ "reactions/list-for-issue": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ content?: | "+1" | "-1" @@ -95422,7 +100313,7 @@ export interface operations { }; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ "reactions/create-for-issue": { parameters: { @@ -95436,7 +100327,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the issue. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the issue. * @enum {string} */ content: @@ -95469,9 +100360,10 @@ export interface operations { }; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). */ "reactions/delete-for-issue": { parameters: { @@ -95564,7 +100456,7 @@ export interface operations { /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.10/articles/permission-levels-for-a-user-account-repository/)." + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.14/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.14/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; @@ -95833,13 +100725,16 @@ export interface operations { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ "licenses/get-for-repo": { parameters: { + query?: { + ref?: components["parameters"]["git-ref"]; + }; path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; @@ -96157,7 +101052,7 @@ export interface operations { }; /** * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ "activity/mark-repo-notifications-as-read": { parameters: { @@ -96234,7 +101129,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.10/articles/using-a-custom-domain-with-github-pages/)." */ + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.14/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -96481,6 +101376,49 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + "repos/get-pages-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["pages-deployment-status"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + "repos/cancel-pages-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List pre-receive hooks for a repository * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. @@ -96649,6 +101587,61 @@ 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 read 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"]; + }; + }; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + "repos/create-or-update-custom-properties-values": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + responses: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { + content: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List pull requests * @description Lists pull requests in a specified repository. @@ -96656,10 +101649,10 @@ export interface operations { * 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-server@3.10/github/getting-started-with-github/githubs-products) + * Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96703,13 +101696,13 @@ export interface operations { }; /** * Create a pull request - * @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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96740,9 +101733,9 @@ export interface operations { base: string; /** @description The contents of the pull request. */ body?: string; - /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.10/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.14/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ maintainer_can_modify?: boolean; - /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/enterprise-server@3.10/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ + /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/enterprise-server@3.14/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** * Format: int64 @@ -96773,7 +101766,7 @@ export interface operations { * @description Lists review comments for all pull requests in a repository. By default, * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96811,7 +101804,7 @@ export interface operations { * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96860,7 +101853,7 @@ export interface operations { * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96894,12 +101887,12 @@ 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/rest/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.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ content?: | "+1" | "-1" @@ -96933,7 +101926,7 @@ export interface operations { }; /** * Create reaction for a pull request review comment - * @description Create a reaction 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). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ "reactions/create-for-pull-request-review-comment": { parameters: { @@ -96947,7 +101940,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the pull request review comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the pull request review comment. * @enum {string} */ content: @@ -96980,9 +101973,10 @@ export interface operations { }; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction 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). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/delete-for-pull-request-comment": { parameters: { @@ -97002,23 +101996,23 @@ export interface operations { }; /** * Get a pull request - * @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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.14/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97035,7 +102029,7 @@ export interface operations { }; }; responses: { - /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ + /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -97050,11 +102044,11 @@ export interface operations { }; /** * Update a pull request - * @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-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97083,7 +102077,7 @@ export interface operations { state?: "open" | "closed"; /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ base?: string; - /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.10/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.14/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ maintainer_can_modify?: boolean; }; }; @@ -97104,7 +102098,7 @@ export interface operations { * @description Lists all review comments for a specified pull request. By default, review comments * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97141,16 +102135,16 @@ export interface operations { }; /** * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#create-an-issue-comment)." + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.14/rest/issues/comments#create-an-issue-comment)." * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97176,20 +102170,20 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** - * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/enterprise-server@3.10/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/enterprise-server@3.14/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ side?: "LEFT" | "RIGHT"; /** @description **Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ line?: number; - /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ + /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ start_line?: number; /** - * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.10/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.14/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ start_side?: "LEFT" | "RIGHT" | "side"; @@ -97225,10 +102219,10 @@ export interface operations { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97269,10 +102263,10 @@ export interface operations { /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits) + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits) * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97307,10 +102301,10 @@ export interface operations { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97370,7 +102364,7 @@ export interface operations { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." */ "pulls/merge": { parameters: { @@ -97429,7 +102423,7 @@ export interface operations { }; /** * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { @@ -97523,7 +102517,7 @@ export interface operations { * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97558,15 +102552,16 @@ export interface operations { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97589,7 +102584,7 @@ export interface operations { /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ body?: string; /** - * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. + * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; @@ -97628,7 +102623,7 @@ export interface operations { * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97658,7 +102653,7 @@ export interface operations { * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97696,7 +102691,7 @@ export interface operations { * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97727,7 +102722,7 @@ export interface operations { * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97764,11 +102759,10 @@ export interface operations { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.14/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97810,9 +102804,9 @@ export interface operations { }; /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.14/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -97856,6 +102850,7 @@ export interface operations { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -97868,7 +102863,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ + /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ expected_head_sha?: string; } | null; }; @@ -97891,7 +102886,7 @@ export interface operations { * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -97914,6 +102909,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -97922,7 +102918,7 @@ export interface operations { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -97953,7 +102949,7 @@ export interface operations { }; /** * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-tags). + * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ @@ -97985,7 +102981,7 @@ export interface operations { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." */ "repos/create-release": { parameters: { @@ -98045,7 +103041,13 @@ export interface operations { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ "repos/get-release-asset": { parameters: { @@ -98117,7 +103119,7 @@ export interface operations { }; /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ "repos/generate-release-notes": { parameters: { @@ -98199,9 +103201,8 @@ export interface operations { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ "repos/get-release": { parameters: { @@ -98212,7 +103213,7 @@ export interface operations { }; }; responses: { - /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ + /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { content: { "application/json": components["schemas"]["release"]; @@ -98315,8 +103316,8 @@ export interface operations { }; /** * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release) to upload a release asset. + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * @@ -98330,9 +103331,9 @@ export interface operations { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets)" + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ "repos/upload-release-asset": { @@ -98367,12 +103368,12 @@ export interface operations { }; /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). + * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). */ "reactions/list-for-release": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -98398,7 +103399,7 @@ export interface operations { }; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ "reactions/create-for-release": { parameters: { @@ -98412,7 +103413,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the release. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the release. * @enum {string} */ content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; @@ -98437,9 +103438,10 @@ export interface operations { }; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.14/rest/releases/releases#get-a-release). */ "reactions/delete-for-release": { parameters: { @@ -98495,6 +103497,258 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get rules for a branch + * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. + */ + "repos/get-branch-rules": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-rule-detailed"][]; + }; + }; + }; + }; + /** + * Get all repository rulesets + * @description Get all the rulesets for a repository. + */ + "repos/get-repo-rulesets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + /** @description Include rulesets configured at higher levels that apply to this repository */ + includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Create a repository ruleset + * @description Create a ruleset for a repository. + */ + "repos/create-repo-ruleset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + /** @description Request body */ + requestBody: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name: string; + /** + * @description The target of the ruleset + * @default branch + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 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-server@3.14/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-server@3.14/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. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + "repos/get-repo-ruleset": { + parameters: { + query?: { + /** @description Include rulesets configured at higher levels that apply to this repository */ + includes_parents?: boolean; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Update a repository ruleset + * @description Update a ruleset for a repository. + */ + "repos/update-repo-ruleset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + /** @description Request body */ + requestBody?: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name?: string; + /** + * @description The target of the ruleset + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Delete a repository ruleset + * @description Delete a ruleset for a repository. + */ + "repos/delete-repo-ruleset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. @@ -98515,6 +103769,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { owner: components["parameters"]["owner"]; @@ -98654,7 +103909,7 @@ export interface operations { * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -98913,7 +104168,7 @@ export interface operations { }; /** * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#delete-a-repository-subscription) completely. + * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#delete-a-repository-subscription) completely. */ "activity/set-repo-subscription": { parameters: { @@ -98943,7 +104198,7 @@ export interface operations { }; /** * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#set-a-repository-subscription). + * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription). */ "activity/delete-repo-subscription": { parameters: { @@ -98984,8 +104239,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -99008,8 +104267,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -99039,8 +104302,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -99065,7 +104332,9 @@ export interface operations { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -99151,7 +104420,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -99169,7 +104438,7 @@ export interface operations { }; /** * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.10/articles/about-repository-transfers/). + * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.14/articles/about-repository-transfers/). */ "repos/transfer": { parameters: { @@ -99201,7 +104470,7 @@ export interface operations { }; /** * Check if vulnerability alerts are enabled for a repository - * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/check-vulnerability-alerts": { parameters: { @@ -99223,7 +104492,7 @@ export interface operations { }; /** * Enable vulnerability alerts - * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/enable-vulnerability-alerts": { parameters: { @@ -99243,7 +104512,7 @@ export interface operations { * Disable vulnerability alerts * @description Disables dependency alerts for a repository. * The authenticated user must have admin access to the repository. For more information, - * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/disable-vulnerability-alerts": { parameters: { @@ -99265,7 +104534,8 @@ export interface operations { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ "repos/download-zipball-archive": { parameters: { @@ -99288,7 +104558,7 @@ export interface operations { }; /** * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ @@ -99342,7 +104612,7 @@ export interface operations { * * Note: * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ "repos/list-public": { parameters: { @@ -99369,7 +104639,8 @@ export interface operations { }; /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -99404,7 +104675,8 @@ export interface operations { }; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -99438,7 +104710,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ @@ -99469,7 +104742,8 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -99505,9 +104779,10 @@ export interface operations { }; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { @@ -99531,7 +104806,8 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -99573,7 +104849,8 @@ export interface operations { }; /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -99607,7 +104884,8 @@ export interface operations { }; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -99643,7 +104921,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ @@ -99671,13 +104950,15 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { @@ -99709,7 +104990,8 @@ export interface operations { }; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ @@ -99735,25 +105017,28 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { @@ -99785,9 +105070,9 @@ export interface operations { }; /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -99807,9 +105092,9 @@ export interface operations { "search/code": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; @@ -99836,10 +105121,10 @@ export interface operations { }; /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -99848,9 +105133,9 @@ export interface operations { "search/commits": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -99873,10 +105158,10 @@ export interface operations { }; /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -99884,14 +105169,15 @@ export interface operations { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.14/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ "search/issues-and-pull-requests": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results) */ sort?: | "comments" | "reactions" @@ -99928,9 +105214,9 @@ export interface operations { }; /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -99943,9 +105229,9 @@ export interface operations { query: { /** @description The id of the repository. */ repository_id: number; - /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). */ + /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). */ q: string; - /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -99971,9 +105257,9 @@ export interface operations { }; /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -99984,9 +105270,9 @@ export interface operations { "search/repos": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.10/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.14/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -100011,9 +105297,9 @@ export interface operations { }; /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.10/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.14/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -100024,7 +105310,7 @@ export interface operations { "search/topics": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). */ q: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -100046,9 +105332,9 @@ export interface operations { }; /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -100056,14 +105342,14 @@ export interface operations { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.14/graphql/reference/queries#search)." */ "search/users": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -100151,7 +105437,8 @@ export interface operations { }; /** * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * @description > [!NOTE] + * > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ "enterprise-admin/enable-or-disable-maintenance-mode": { requestBody: { @@ -100183,9 +105470,10 @@ export interface operations { }; /** * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#set-settings). + * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * > [!NOTE] + * > You cannot retrieve the management console password with the Enterprise administration API. */ "enterprise-admin/get-settings": { responses: { @@ -100203,18 +105491,18 @@ export interface operations { }; /** * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings). + * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings). * * **Notes:** * * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." */ "enterprise-admin/set-settings": { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings). */ + /** @description A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings). */ settings: string; }; }; @@ -100301,14 +105589,15 @@ export interface operations { * Create a GitHub license * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. * * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/create-enterprise-server-license": { requestBody: { @@ -100318,7 +105607,7 @@ export interface operations { license: string; /** @description You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. */ password?: string; - /** @description An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings). */ + /** @description An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings). */ settings?: string; }; }; @@ -100338,7 +105627,8 @@ export interface operations { * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ "enterprise-admin/upgrade-license": { requestBody?: { @@ -100363,7 +105653,8 @@ export interface operations { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#get-a-team-by-name) endpoint. */ "teams/get-legacy": { parameters: { @@ -100384,7 +105675,8 @@ export interface operations { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -100408,11 +105700,13 @@ export interface operations { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -100447,7 +105741,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -100478,7 +105772,8 @@ export interface operations { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -100510,11 +105805,12 @@ export interface operations { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -100551,7 +105847,8 @@ export interface operations { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -100576,7 +105873,8 @@ export interface operations { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -100599,7 +105897,8 @@ export interface operations { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -100634,7 +105933,8 @@ export interface operations { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -100667,11 +105967,12 @@ export interface operations { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -100702,7 +106003,8 @@ export interface operations { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -100728,7 +106030,8 @@ export interface operations { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -100752,7 +106055,8 @@ export interface operations { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -100786,16 +106090,17 @@ export interface operations { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: | "+1" | "-1" @@ -100829,9 +106134,10 @@ export interface operations { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * @@ -100849,7 +106155,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: @@ -100876,16 +106182,17 @@ export interface operations { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: | "+1" | "-1" @@ -100918,9 +106225,10 @@ export interface operations { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * @@ -100937,7 +106245,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: @@ -100964,7 +106272,8 @@ export interface operations { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.10/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.14/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -100996,9 +106305,9 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. */ @@ -101023,17 +106332,18 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "teams/add-member-legacy": { parameters: { @@ -101061,15 +106371,16 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-member-legacy": { parameters: { @@ -101092,7 +106403,8 @@ export interface operations { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -101101,7 +106413,7 @@ export interface operations { * **Note:** * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#create-a-team). */ "teams/get-membership-for-user-legacy": { parameters: { @@ -101123,13 +106435,15 @@ export interface operations { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -101175,13 +106489,15 @@ export interface operations { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.14/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.14/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-membership-for-user-legacy": { parameters: { @@ -101204,7 +106520,8 @@ export interface operations { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -101234,7 +106551,8 @@ export interface operations { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -101261,7 +106579,8 @@ export interface operations { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -101276,7 +106595,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -101304,7 +106623,8 @@ export interface operations { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -101327,7 +106647,8 @@ export interface operations { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-repositories) endpoint. */ "teams/list-repos-legacy": { parameters: { @@ -101355,11 +106676,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -101389,11 +106712,12 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "teams/add-or-update-repo-permissions-legacy": { parameters: { @@ -101426,7 +106750,8 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -101448,7 +106773,8 @@ export interface operations { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-child-teams) endpoint. */ "teams/list-child-legacy": { parameters: { @@ -101731,7 +107057,7 @@ export interface operations { }; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ @@ -101750,6 +107076,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -101955,6 +107282,8 @@ export interface operations { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -101976,6 +107305,8 @@ export interface operations { /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -102002,12 +107333,10 @@ export interface operations { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -102410,6 +107739,9 @@ export interface operations { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -102437,7 +107769,7 @@ export interface operations { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-authenticated-user": { parameters: { @@ -102469,7 +107801,7 @@ export interface operations { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-authenticated-user": { parameters: { @@ -102491,7 +107823,7 @@ export interface operations { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-authenticated-user": { parameters: { @@ -102518,7 +107850,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-authenticated-user": { parameters: { @@ -102545,7 +107877,7 @@ export interface operations { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { @@ -102576,7 +107908,7 @@ export interface operations { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-authenticated-user": { parameters: { @@ -102601,7 +107933,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-authenticated-user": { parameters: { @@ -102629,7 +107961,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-authenticated-user": { parameters: { @@ -102686,7 +108018,7 @@ export interface operations { /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) * endpoint. * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -102853,7 +108185,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -102870,7 +108204,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -103116,7 +108452,7 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.10/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.14/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ key: string; }; }; @@ -103187,7 +108523,7 @@ export interface operations { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -103245,7 +108581,7 @@ export interface operations { }; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "activity/star-repo-for-authenticated-user": { parameters: { @@ -103344,11 +108680,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.14/rest/users/emails)". + */ + "users/get-by-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ "users/list": { parameters: { @@ -103375,9 +108737,9 @@ export interface operations { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.10/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.14/rest/users/emails)". */ "users/get-by-username": { parameters: { @@ -103422,7 +108784,10 @@ export interface operations { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-events-for-authenticated-user": { parameters: { @@ -103446,6 +108811,9 @@ export interface operations { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-org-events-for-authenticated-user": { parameters: { @@ -103467,7 +108835,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-user": { parameters: { query?: { @@ -103647,7 +109019,7 @@ export interface operations { * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-user-installation": { parameters: { @@ -103692,9 +109064,9 @@ export interface operations { }; /** * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.10/articles/publicizing-or-concealing-organization-membership) for the specified user. + * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.14/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ "orgs/list-for-user": { parameters: { @@ -103722,7 +109094,7 @@ export interface operations { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-user": { parameters: { @@ -103759,7 +109131,7 @@ export interface operations { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-user": { parameters: { @@ -103782,9 +109154,9 @@ export interface operations { * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-user": { parameters: { @@ -103812,9 +109184,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-user": { parameters: { @@ -103842,7 +109214,7 @@ export interface operations { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { @@ -103868,7 +109240,7 @@ export interface operations { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-user": { parameters: { @@ -103892,9 +109264,9 @@ export interface operations { * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-user": { parameters: { @@ -103923,9 +109295,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-user": { parameters: { @@ -103977,7 +109349,11 @@ export interface operations { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-received-events-for-user": { parameters: { @@ -103998,7 +109374,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-received-public-events-for-user": { parameters: { query?: { @@ -104052,7 +109432,7 @@ export interface operations { }; /** * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "enterprise-admin/promote-user-to-be-site-administrator": { parameters: { @@ -104140,7 +109520,7 @@ export interface operations { * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -104198,11 +109578,11 @@ export interface operations { }; /** * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * * You can suspend any user account except your own. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." */ "enterprise-admin/suspend-user": { parameters: { @@ -104213,7 +109593,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Suspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ + /** @description The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Suspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ reason?: string; } | null; }; @@ -104227,7 +109607,7 @@ export interface operations { }; /** * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ "enterprise-admin/unsuspend-user": { parameters: { @@ -104238,7 +109618,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Unsuspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ + /** @description The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Unsuspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ reason?: string; } | null; }; diff --git a/packages/openapi-types-ghes-3.9/LICENSE b/packages/openapi-types-ghes-3.15/LICENSE similarity index 100% rename from packages/openapi-types-ghes-3.9/LICENSE rename to packages/openapi-types-ghes-3.15/LICENSE diff --git a/packages/openapi-types-ghes-3.10/README.md b/packages/openapi-types-ghes-3.15/README.md similarity index 72% rename from packages/openapi-types-ghes-3.10/README.md rename to packages/openapi-types-ghes-3.15/README.md index 6042daad3..4edf46ed6 100644 --- a/packages/openapi-types-ghes-3.10/README.md +++ b/packages/openapi-types-ghes-3.15/README.md @@ -1,13 +1,13 @@ -# @octokit/openapi-types-ghes-3.10 +# @octokit/openapi-types-ghes-3.15 -> Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.10 +> Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.15 This package is continuously updated based on [GitHub's OpenAPI specification](https://github.com/github/rest-api-description/) ## Usage ```ts -import { components } from "@octokit/openapi-types-ghes-3.10"; +import { components } from "@octokit/openapi-types-ghes-3.15"; type Repository = components["schemas"]["full-repository"]; ``` diff --git a/packages/openapi-types-ghes-3.9/package.json b/packages/openapi-types-ghes-3.15/package.json similarity index 71% rename from packages/openapi-types-ghes-3.9/package.json rename to packages/openapi-types-ghes-3.15/package.json index 8b62a0849..050757d0a 100644 --- a/packages/openapi-types-ghes-3.9/package.json +++ b/packages/openapi-types-ghes-3.15/package.json @@ -1,10 +1,10 @@ { - "name": "@octokit/openapi-types-ghes-3.9", - "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.9", + "name": "@octokit/openapi-types-ghes-3.15", + "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for ghes-3.15", "repository": { "type": "git", "url": "https://github.com/octokit/openapi-types.ts.git", - "directory": "packages/openapi-types-ghes-3.9" + "directory": "packages/openapi-types-ghes-3.15" }, "publishConfig": { "access": "public", @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.6.0" + "openapi-version": "17.1.0" } } diff --git a/packages/openapi-types-ghes-3.9/types.d.ts b/packages/openapi-types-ghes-3.15/types.d.ts similarity index 86% rename from packages/openapi-types-ghes-3.9/types.d.ts rename to packages/openapi-types-ghes-3.15/types.d.ts index 5c4a57192..48ba04f4a 100644 --- a/packages/openapi-types-ghes-3.9/types.d.ts +++ b/packages/openapi-types-ghes-3.15/types.d.ts @@ -42,7 +42,7 @@ export interface paths { "/admin/hooks/{hook_id}/pings": { /** * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) to be sent to the webhook. */ post: operations["enterprise-admin/ping-global-webhook"]; }; @@ -57,7 +57,7 @@ export interface paths { "/admin/ldap/teams/{team_id}/mapping": { /** * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. + * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ patch: operations["enterprise-admin/update-ldap-mapping-for-team"]; }; @@ -165,7 +165,7 @@ export interface paths { "/admin/users": { /** * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * @@ -176,7 +176,7 @@ export interface paths { "/admin/users/{username}": { /** * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user) is often a better option. + * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#suspend-a-user) is often a better option. * * You can delete any user account except your own. */ @@ -190,19 +190,35 @@ export interface paths { /** Delete an impersonation OAuth token */ delete: operations["enterprise-admin/delete-impersonation-o-auth-token"]; }; + "/advisories": { + /** + * List global security advisories + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.15/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + */ + get: operations["security-advisories/list-global-advisories"]; + }; + "/advisories/{ghsa_id}": { + /** + * Get a global security advisory + * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + */ + get: operations["security-advisories/get-global-advisory"]; + }; "/app": { /** * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; }; "/app-manifests/{code}/conversions": { /** * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; }; @@ -211,14 +227,14 @@ export interface paths { * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; }; @@ -227,7 +243,7 @@ export interface paths { * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; }; @@ -236,7 +252,7 @@ export interface paths { * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; }; @@ -245,7 +261,7 @@ export interface paths { * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; }; @@ -270,14 +286,14 @@ export interface paths { * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; }; @@ -292,7 +308,7 @@ export interface paths { * * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; }; @@ -301,14 +317,14 @@ export interface paths { * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; }; @@ -316,9 +332,10 @@ export interface paths { /** * List your grants * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ get: operations["oauth-authorizations/list-grants"]; }; @@ -326,13 +343,15 @@ export interface paths { /** * Get a single grant * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ get: operations["oauth-authorizations/get-grant"]; /** * Delete a grant * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -341,7 +360,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; @@ -349,17 +368,17 @@ export interface paths { "/applications/{client_id}/token": { /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -371,17 +390,14 @@ export interface paths { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; }; @@ -389,23 +405,26 @@ export interface paths { /** * List your authorizations * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ get: operations["oauth-authorizations/list-authorizations"]; /** * Create a new authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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). * - * Creates 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)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.15/rest/authentication/authenticating-to-the-rest-api#using-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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * - * 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). + * 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.15/articles/creating-an-access-token-for-command-line-use). * - * 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. + * 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.15/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"]; }; @@ -413,15 +432,15 @@ export interface paths { /** * Get-or-create an authorization for a specific app * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." - * - * **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/). + * 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; }; @@ -429,13 +448,15 @@ export interface paths { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." + * 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; }; @@ -443,21 +464,24 @@ export interface paths { /** * Get a single authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ get: operations["oauth-authorizations/get-authorization"]; /** * Delete an authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ delete: operations["oauth-authorizations/delete-authorization"]; /** * Update an existing authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * 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)." + * 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * You can only send one of these scope keys at a time. */ @@ -545,6 +569,15 @@ export interface paths { /** Get repository statistics */ get: operations["enterprise-admin/get-repo-stats"]; }; + "/enterprise/stats/security-products": { + /** + * Get security products statistics + * @description Gets the statistics about security products for a GitHub Enterprise Server instance. + * + * To use this endpoint, you must be a site admin. + */ + get: operations["enterprise-admin/get-security-products"]; + }; "/enterprise/stats/users": { /** Get users statistics */ get: operations["enterprise-admin/get-user-stats"]; @@ -644,7 +677,7 @@ export interface paths { * Get default workflow permissions for an enterprise * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -653,7 +686,7 @@ export interface paths { * Set default workflow permissions for an enterprise * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets * whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -780,6 +813,15 @@ export interface paths { */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; }; + "/enterprises/{enterprise}/actions/runners/generate-jitconfig": { + /** + * Create configuration for a just-in-time runner for an Enterprise + * @description Generates a configuration that can be passed to the runner application at startup. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + */ + post: operations["actions/generate-runner-jitconfig-for-enterprise"]; + }; "/enterprises/{enterprise}/actions/runners/registration-token": { /** * Create a registration token for an enterprise @@ -890,7 +932,7 @@ export interface paths { "/enterprises/{enterprise}/code-scanning/alerts": { /** * List code scanning alerts for an enterprise - * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be a member of the enterprise to use this endpoint. * @@ -905,7 +947,7 @@ export interface paths { * * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ get: operations["secret-scanning/get-security-analysis-settings-for-enterprise"]; /** @@ -925,7 +967,7 @@ export interface paths { * * The authenticated user must be a member of the enterprise to use this endpoint. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ @@ -935,7 +977,7 @@ export interface paths { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. */ get: operations["secret-scanning/list-alerts-for-enterprise"]; }; @@ -964,7 +1006,8 @@ export interface paths { "/events": { /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; }; @@ -974,16 +1017,17 @@ export interface paths { * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.15/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -997,7 +1041,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; }; @@ -1006,7 +1051,7 @@ export interface paths { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; }; @@ -1022,7 +1067,7 @@ export interface paths { * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1041,7 +1086,7 @@ export interface paths { * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1051,7 +1096,7 @@ export interface paths { * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1063,7 +1108,7 @@ export interface paths { * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1075,7 +1120,7 @@ export interface paths { * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1097,7 +1142,7 @@ export interface paths { get: operations["gists/check-is-starred"]; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; /** Unstar a gist */ @@ -1108,7 +1153,7 @@ export interface paths { * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -1118,7 +1163,7 @@ export interface paths { "/gitignore/templates": { /** * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-the-authenticated-user). + * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; }; @@ -1127,7 +1172,7 @@ export interface paths { * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ @@ -1145,7 +1190,7 @@ export interface paths { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; }; @@ -1156,12 +1201,10 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -1173,24 +1216,142 @@ export interface paths { "/licenses": { /** * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; }; "/licenses/{license}": { /** * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; }; + "/manage/v1/access/ssh": { + /** + * Get the configured SSH keys + * @description Gets the configured SSH keys on all available nodes. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + get: operations["enterprise-admin/get-manage-ssh"]; + /** + * Set a new SSH key + * @description Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + post: operations["enterprise-admin/set-manage-ssh"]; + /** + * Delete a SSH key + * @description Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + delete: operations["enterprise-admin/delete-manage-ssh"]; + }; + "/manage/v1/checks/system-requirements": { + /** + * Get the system requirement check results for configured cluster nodes + * @description Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + * This endpoint may take several seconds to reply. + */ + get: operations["enterprise-admin/get-checks-system-requirements"]; + }; + "/manage/v1/cluster/status": { + /** + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. + */ + get: operations["enterprise-admin/get-cluster-status"]; + }; + "/manage/v1/config/apply": { + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + get: operations["enterprise-admin/get-manage-config-apply-status"]; + /** + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + post: operations["enterprise-admin/post-manage-run-config-apply"]; + }; + "/manage/v1/config/apply/events": { + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + get: operations["enterprise-admin/get-manage-config-apply-events"]; + }; + "/manage/v1/config/init": { + /** + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + * + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + * + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + post: operations["enterprise-admin/initialize-instance-configuration"]; + }; + "/manage/v1/config/license": { + /** + * Get the enterprise license information + * @description Gets information about the license that is currently set for the enterprise. + */ + get: operations["enterprise-admin/license-info"]; + /** + * Upload an enterprise license + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + put: operations["enterprise-admin/license-upload"]; + }; + "/manage/v1/config/license/check": { + /** + * Check a license + * @description Check the status of the license that is currently set for the enterprise. + */ + get: operations["enterprise-admin/license-check"]; + }; "/manage/v1/config/nodes": { /** * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering)." + * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.15/admin/enterprise-management/configuring-clustering/about-clustering)." */ get: operations["enterprise-admin/get-config-nodes"]; }; + "/manage/v1/config/settings": { + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + get: operations["enterprise-admin/get-manage-settings"]; + /** + * Set settings + * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-settings). + * + * **Notes:** + * - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + * - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + */ + put: operations["enterprise-admin/set-manage-settings"]; + }; + "/manage/v1/maintenance": { + /** + * Get the status of maintenance mode + * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + */ + get: operations["enterprise-admin/get-manage-maintenance"]; + /** + * Set the status of maintenance mode + * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + */ + post: operations["enterprise-admin/set-manage-maintenance"]; + }; "/manage/v1/replication/status": { /** * Get the status of services running on all replica nodes @@ -1202,7 +1363,7 @@ export interface paths { "/manage/v1/version": { /** * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.9/admin/all-releases)." + * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.15/admin/all-releases)." */ get: operations["enterprise-admin/get-version"]; }; @@ -1222,7 +1383,11 @@ export interface paths { get: operations["meta/get"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; }; "/notifications": { @@ -1233,7 +1398,7 @@ export interface paths { get: operations["activity/list-notifications-for-authenticated-user"]; /** * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; }; @@ -1243,6 +1408,11 @@ export interface paths { * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications. + */ + delete: operations["activity/mark-thread-as-done"]; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. @@ -1252,7 +1422,7 @@ export interface paths { "/notifications/threads/{thread_id}/subscription": { /** * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription). + * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ @@ -1263,12 +1433,12 @@ export interface paths { * * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; /** * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; }; @@ -1284,18 +1454,19 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; }; "/organizations/{organization_id}/custom_roles": { /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * @@ -1308,21 +1479,10 @@ export interface paths { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.15/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -1336,25 +1496,18 @@ export interface paths { * * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.15/site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version. * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -1474,7 +1627,7 @@ export interface paths { * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -1483,7 +1636,7 @@ export interface paths { * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -1614,6 +1767,17 @@ export interface paths { */ get: operations["actions/list-runner-applications-for-org"]; }; + "/orgs/{org}/actions/runners/generate-jitconfig": { + /** + * Create configuration for a just-in-time runner for an organization + * @description Generates a configuration that can be passed to the runner application at startup. + * + * The authenticated user must have admin access to the organization. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/generate-runner-jitconfig-for-org"]; + }; "/orgs/{org}/actions/runners/registration-token": { /** * Create a registration token for an organization @@ -1861,7 +2025,7 @@ export interface paths { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -1874,7 +2038,7 @@ export interface paths { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -1885,7 +2049,7 @@ export interface paths { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -2010,11 +2174,11 @@ export interface paths { "/orgs/{org}/audit-log": { /** * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -2025,7 +2189,7 @@ export interface paths { "/orgs/{org}/code-scanning/alerts": { /** * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an owner or security manager for the organization to use this endpoint. * @@ -2033,10 +2197,137 @@ export interface paths { */ get: operations["code-scanning/list-alerts-for-org"]; }; + "/orgs/{org}/code-security/configurations": { + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + get: operations["code-security/get-configurations-for-org"]; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error. + */ + post: operations["code-security/create-configuration"]; + }; + "/orgs/{org}/code-security/configurations/defaults": { + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + get: operations["code-security/get-default-configurations"]; + }; + "/orgs/{org}/code-security/configurations/detach": { + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + get: operations["code-security/get-configuration"]; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error. + */ + patch: operations["code-security/update-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + put: operations["code-security/set-configuration-as-default"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + }; "/orgs/{org}/custom-repository-roles": { /** * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2045,7 +2336,7 @@ export interface paths { get: operations["orgs/list-custom-repo-roles"]; /** * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2056,7 +2347,7 @@ export interface paths { "/orgs/{org}/custom-repository-roles/{role_id}": { /** * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2066,7 +2357,7 @@ export interface paths { /** * Delete a custom repository role * @description Deletes a custom role from an organization. Once the custom role has been deleted, any - * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2075,7 +2366,7 @@ export interface paths { delete: operations["orgs/delete-custom-repo-role"]; /** * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2222,7 +2513,7 @@ export interface paths { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2233,7 +2524,7 @@ export interface paths { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2242,7 +2533,7 @@ export interface paths { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -2258,7 +2549,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; }; "/orgs/{org}/external-group/{group_id}": { @@ -2266,7 +2561,7 @@ export interface paths { * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; }; @@ -2275,14 +2570,16 @@ export interface paths { * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; }; "/orgs/{org}/hooks": { /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2313,7 +2610,9 @@ export interface paths { get: operations["orgs/get-webhook"]; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -2395,7 +2694,7 @@ export interface paths { "/orgs/{org}/hooks/{hook_id}/pings": { /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) * to be sent to the hook. * * You must be an organization owner to use this endpoint. @@ -2410,7 +2709,7 @@ export interface paths { * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; }; @@ -2431,12 +2730,10 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -2474,13 +2771,13 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.15/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; /** @@ -2503,7 +2800,7 @@ 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)." + * 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.15/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"]; }; @@ -2536,7 +2833,7 @@ export interface paths { "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { /** * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; }; @@ -2547,6 +2844,186 @@ export interface paths { */ get: operations["migrations/list-repos-for-org"]; }; + "/orgs/{org}/organization-fine-grained-permissions": { + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + }; + "/orgs/{org}/organization-roles": { + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-org-roles"]; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific + * permissions over the organization and optionally across all repositories in the organization. For + * more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To include repository permissions in an organization role, you must also include the `base_role` + * field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of + * fine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions + * and can only be granted through the base role (like "reading a repo"). If you include repository permissions, those + * permissions apply across all of the repositories in the organization. You do not have to include organization permissions + * in order to add repository permissions. + * + * See "[List repository permissions](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-custom-organization-role"]; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}": { + /** + * Remove all organization roles for a team + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-all-org-roles-team"]; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/assign-team-to-org-role"]; + /** + * Remove an organization role from a team + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-org-role-team"]; + }; + "/orgs/{org}/organization-roles/users/{username}": { + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-all-org-roles-user"]; + }; + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/assign-user-to-org-role"]; + /** + * Remove an organization role from a user + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/revoke-org-role-user"]; + }; + "/orgs/{org}/organization-roles/{role_id}": { + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-org-role"]; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-custom-organization-role"]; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either + * previously or as part of the update. + * If the update sets the `base_role` field to `none`, you must also remove all of the repository + * permissions as well, otherwise the update will fail. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["orgs/patch-custom-organization-role"]; + }; + "/orgs/{org}/organization-roles/{role_id}/teams": { + /** + * List teams that are assigned to an organization role + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-org-role-teams"]; + }; + "/orgs/{org}/organization-roles/{role_id}/users": { + /** + * List users that are assigned to an organization role + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-org-role-users"]; + }; "/orgs/{org}/outside_collaborators": { /** * List outside collaborators for an organization @@ -2557,7 +3034,7 @@ export interface paths { "/orgs/{org}/outside_collaborators/{username}": { /** * Convert an organization member to outside collaborator - * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.9/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.15/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; /** @@ -2571,7 +3048,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; }; @@ -2580,16 +3057,16 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; /** * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; }; @@ -2602,9 +3079,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; }; @@ -2613,7 +3090,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; }; @@ -2622,16 +3099,16 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; /** * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; }; @@ -2644,12 +3121,80 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; }; + "/orgs/{org}/personal-access-token-requests": { + /** + * List requests to access organization resources with fine-grained personal access tokens + * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + get: operations["orgs/list-pat-grant-requests"]; + /** + * Review requests to access organization resources with fine-grained personal access tokens + * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + post: operations["orgs/review-pat-grant-requests-in-bulk"]; + }; + "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + /** + * Review a request to access organization resources with a fine-grained personal access token + * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + post: operations["orgs/review-pat-grant-request"]; + }; + "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + /** + * List repositories requested to be accessed by a fine-grained personal access token + * @description Lists the repositories a fine-grained personal access token request is requesting access to. + * + * Only GitHub Apps can use this endpoint. + */ + get: operations["orgs/list-pat-grant-request-repositories"]; + }; + "/orgs/{org}/personal-access-tokens": { + /** + * List fine-grained personal access tokens with access to organization resources + * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. + * + * Only GitHub Apps can use this endpoint. + */ + get: operations["orgs/list-pat-grants"]; + /** + * Update the access to organization resources via fine-grained personal access tokens + * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. + * + * Only GitHub Apps can use this endpoint. + */ + post: operations["orgs/update-pat-accesses"]; + }; + "/orgs/{org}/personal-access-tokens/{pat_id}": { + /** + * Update the access a fine-grained personal access token has to organization resources + * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. + * + * Only GitHub Apps can use this endpoint. + */ + post: operations["orgs/update-pat-access"]; + }; + "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + /** + * List repositories a fine-grained personal access token has access to + * @description Lists the repositories a fine-grained personal access token has access to. + * + * Only GitHub Apps can use this endpoint. + */ + get: operations["orgs/list-pat-grant-repositories"]; + }; "/orgs/{org}/pre-receive-hooks": { /** * List pre-receive hooks for an organization @@ -2683,6 +3228,71 @@ 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. + * Organization members can read these properties. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * Organization members can read these properties. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + */ + patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + }; "/orgs/{org}/public_members": { /** * List public organization members @@ -2700,7 +3310,7 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; /** @@ -2714,7 +3324,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; /** @@ -2728,7 +3339,7 @@ export interface paths { "/orgs/{org}/repository-fine-grained-permissions": { /** * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -2736,6 +3347,54 @@ export interface paths { */ get: operations["orgs/list-repo-fine-grained-permissions"]; }; + "/orgs/{org}/rulesets": { + /** + * Get all organization repository rulesets + * @description Get all the repository rulesets for an organization. + */ + get: operations["repos/get-org-rulesets"]; + /** + * Create an organization repository ruleset + * @description Create a repository ruleset for an organization. + */ + 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-server@3.15/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-server@3.15/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 + * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + get: operations["repos/get-org-ruleset"]; + /** + * Update an organization repository ruleset + * @description Update a ruleset for an organization. + */ + put: operations["repos/update-org-ruleset"]; + /** + * Delete an organization repository ruleset + * @description Delete a ruleset for an organization. + */ + delete: operations["repos/delete-org-ruleset"]; + }; "/orgs/{org}/secret-scanning/alerts": { /** * List secret scanning alerts for an organization @@ -2750,7 +3409,7 @@ export interface paths { "/orgs/{org}/security-managers": { /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * @@ -2761,7 +3420,7 @@ export interface paths { "/orgs/{org}/security-managers/teams/{team_slug}": { /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2770,7 +3429,7 @@ export interface paths { put: operations["orgs/add-security-manager-team"]; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2799,9 +3458,9 @@ export interface paths { get: operations["teams/list"]; /** * Create a team - * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.9/articles/setting-team-creation-permissions-in-your-organization)." + * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.15/articles/setting-team-creation-permissions-in-your-organization)." * - * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; }; @@ -2810,7 +3469,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; /** @@ -2819,14 +3479,16 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; }; @@ -2835,7 +3497,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2844,9 +3507,10 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2857,7 +3521,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2866,7 +3531,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2875,7 +3541,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2886,7 +3553,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2895,9 +3563,10 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2908,7 +3577,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2917,7 +3587,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2926,7 +3597,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2935,20 +3607,22 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2957,9 +3631,10 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2968,20 +3643,22 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2990,9 +3667,10 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -3003,21 +3681,21 @@ export interface paths { * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; }; @@ -3037,38 +3715,43 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; /** * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; }; @@ -3077,7 +3760,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; }; @@ -3086,21 +3770,24 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; }; @@ -3109,7 +3796,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; }; @@ -3118,29 +3806,32 @@ export interface paths { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * - * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; }; @@ -3149,18 +3840,23 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; }; "/orgs/{org}/{security_product}/{enablement}": { /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -3267,20 +3963,22 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.9/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.9/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.9/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.9/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.15/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.15/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.15/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.15/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.15/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.15/rest/about-the-rest-api/api-versions)." + * + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; }; @@ -3289,7 +3987,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; /** @@ -3304,7 +4003,7 @@ export interface paths { delete: operations["repos/delete"]; /** * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics) endpoint. + * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; }; @@ -3493,8 +4192,8 @@ export interface paths { * Get the level of access for workflows outside of the repository * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3503,8 +4202,8 @@ export interface paths { * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3535,7 +4234,7 @@ export interface paths { * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3544,7 +4243,7 @@ export interface paths { * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -3572,6 +4271,17 @@ export interface paths { */ get: operations["actions/list-runner-applications-for-repo"]; }; + "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + /** + * 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. + * + * The authenticated user must have admin access to the repository. + * + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + */ + post: operations["actions/generate-runner-jitconfig-for-repo"]; + }; "/repos/{owner}/{repo}/actions/runners/registration-token": { /** * Create a registration token for a repository @@ -3684,13 +4394,13 @@ export interface paths { "/repos/{owner}/{repo}/actions/runs": { /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; }; @@ -3749,7 +4459,7 @@ export interface paths { /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -3778,11 +4488,33 @@ export interface paths { */ post: operations["actions/cancel-workflow-run"]; }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + /** + * Review custom deployment protection rules for a workflow run + * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + 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). + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope 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 * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -3884,7 +4616,7 @@ export interface paths { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -4005,18 +4737,30 @@ export interface paths { "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; }; + "/repos/{owner}/{repo}/activity": { + /** + * 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. + * + * For more information about viewing repository activity, + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.15/repositories/viewing-activity-and-data-for-your-repository)." + */ + get: operations["repos/list-activities"]; + }; "/repos/{owner}/{repo}/assignees": { /** * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.9/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.15/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; }; @@ -4061,6 +4805,13 @@ export interface paths { */ delete: operations["repos/delete-autolink"]; }; + "/repos/{owner}/{repo}/automated-security-fixes": { + /** + * Check if automated security fixes are enabled for a repository + * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.15/articles/configuring-automated-security-fixes)". + */ + get: operations["repos/check-automated-security-fixes"]; + }; "/repos/{owner}/{repo}/branches": { /** List branches */ get: operations["repos/list-branches"]; @@ -4072,42 +4823,44 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection": { /** * Get branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-branch-protection"]; /** * Update branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; /** * Delete branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { /** * Get admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; /** * Set admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -4116,44 +4869,46 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { /** * Get pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; /** * Delete pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; /** * Update pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { /** * Get commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.9/articles/signing-commits-with-gpg) in GitHub Help. + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.15/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; /** * Create commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -4162,17 +4917,17 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { /** * Get status checks protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; /** * Remove status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; /** * Update status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -4181,38 +4936,39 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { /** * Get all status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-all-status-check-contexts"]; /** * Set status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ put: operations["repos/set-status-check-contexts"]; /** * Add status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ post: operations["repos/add-status-check-contexts"]; /** * Remove status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { /** * Get access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; /** * Delete access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -4221,28 +4977,28 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { /** * Get apps with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -4251,28 +5007,28 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { /** * Get teams with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ @@ -4281,14 +5037,14 @@ export interface paths { "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { /** * Get users with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -4299,7 +5055,7 @@ export interface paths { put: operations["repos/set-user-access-restrictions"]; /** * Add user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -4310,7 +5066,7 @@ export interface paths { post: operations["repos/add-user-access-restrictions"]; /** * Remove user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -4325,7 +5081,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -4349,7 +5106,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4358,7 +5116,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4376,9 +5135,9 @@ export interface paths { "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4387,9 +5146,10 @@ export interface paths { "/repos/{owner}/{repo}/check-suites": { /** * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites)". + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.15/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4398,7 +5158,7 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/preferences": { /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite). + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; @@ -4408,7 +5168,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4419,7 +5180,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4428,7 +5190,7 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { /** * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4437,16 +5199,13 @@ export interface paths { "/repos/{owner}/{repo}/code-scanning/alerts": { /** * List code scanning alerts for a repository - * @description Lists all open code scanning alerts for the default branch (usually `main` - * or `master`). You must use an access token with the `security_events` scope to use - * this endpoint with private repos, the `public_repo` scope also grants permission to read - * security events on public repos only. GitHub Apps must have the `security_events` read - * permission to use this endpoint. + * @description Lists code scanning alerts. * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert - * for the default branch or for the specified Git reference - * (if you used `ref` in the request). + * for the default branch (or for the specified Git reference if you used `ref` in the request). + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-repo"]; }; @@ -4488,8 +5247,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -4510,7 +5269,7 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * @@ -4605,7 +5364,7 @@ export interface paths { "/repos/{owner}/{repo}/code-scanning/sarifs": { /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -4618,7 +5377,7 @@ export interface paths { * ``` * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -4637,6 +5396,8 @@ export interface paths { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -4648,6 +5409,17 @@ export interface paths { */ get: operations["code-scanning/get-sarif"]; }; + "/repos/{owner}/{repo}/code-security-configuration": { + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + }; "/repos/{owner}/{repo}/codeowners/errors": { /** * List CODEOWNERS errors @@ -4655,7 +5427,7 @@ export interface paths { * file. * * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * see "[About code owners](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; }; @@ -4687,17 +5459,17 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Updating an existing collaborator's permission level** * @@ -4722,11 +5494,12 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; }; @@ -4748,7 +5521,7 @@ export interface paths { * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4762,7 +5535,7 @@ export interface paths { * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4776,7 +5549,7 @@ export interface paths { * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4788,21 +5561,22 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). + * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; }; @@ -4819,6 +5593,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -4843,7 +5618,7 @@ export interface paths { "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { /** * List branches for HEAD commit - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -4854,7 +5629,7 @@ export interface paths { * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4866,9 +5641,9 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -4891,9 +5666,10 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -4909,6 +5685,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -4935,9 +5712,10 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. + * 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.15/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.15/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4948,7 +5726,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4980,11 +5759,11 @@ export interface paths { "/repos/{owner}/{repo}/compare/{basehead}": { /** * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.15/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.diff`**: Returns the diff of the commit. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -4997,10 +5776,10 @@ export interface paths { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api)." * * **Signature verification object** * @@ -5012,6 +5791,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5038,7 +5818,7 @@ export interface paths { * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -5052,9 +5832,9 @@ export interface paths { * * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.15/rest/git/trees#get-a-tree). * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.15/rest/git/trees#get-a-tree). * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. * - If the requested file's size is: * - 1 MB or smaller: All features of this endpoint are supported. @@ -5067,7 +5847,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.15/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -5082,7 +5863,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.15/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -5110,7 +5892,7 @@ export interface paths { get: operations["dependabot/get-alert"]; /** * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -5148,7 +5930,7 @@ export interface paths { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5208,7 +5990,7 @@ export interface paths { * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) for every submitted context must be in a `success` + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.15/rest/commits/statuses) for every submitted context must be in a `success` * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do * not require any contexts or create any commit statuses, the deployment will always succeed. @@ -5257,7 +6039,7 @@ export interface paths { * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * * Mark the active deployment as inactive by adding any non-successful deployment status. * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#create-a-deployment-status)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ @@ -5287,7 +6069,7 @@ export interface paths { "/repos/{owner}/{repo}/dispatches": { /** * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#repository_dispatch)." + * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#repository_dispatch)." * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * @@ -5311,7 +6093,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -5322,9 +6105,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5347,7 +6132,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5356,7 +6141,7 @@ 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. * @@ -5365,19 +6150,76 @@ export interface paths { 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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope 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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; }; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + /** + * Get all deployment protection rules for an environment + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + get: operations["repos/get-all-deployment-protection-rules"]; + /** + * Create a custom deployment protection rule on an environment + * @description Enable a custom deployment protection rule for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["repos/create-deployment-protection-rule"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + /** + * List custom deployment rule integrations available for an environment + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app)". + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + get: operations["repos/list-custom-deployment-rule-integrations"]; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + /** + * Get a custom deployment protection rule + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + get: operations["repos/get-custom-deployment-protection-rule"]; + /** + * Disable a custom protection rule for an environment + * @description Disables a custom deployment protection rule for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["repos/disable-deployment-protection-rule"]; + }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { /** * List environment secrets @@ -5415,7 +6257,7 @@ export interface paths { /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -5484,7 +6326,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; }; @@ -5495,9 +6338,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; }; @@ -5510,7 +6355,7 @@ export interface paths { * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw blob data. * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -5534,6 +6379,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5572,6 +6418,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5600,7 +6447,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -5611,7 +6459,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; }; @@ -5637,7 +6486,7 @@ export interface paths { "/repos/{owner}/{repo}/git/tags": { /** * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.15/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.15/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * * **Signature verification object** * @@ -5649,6 +6498,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5683,6 +6533,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5709,7 +6560,7 @@ export interface paths { * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.15/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.15/rest/git/refs#update-a-reference)." * * Returns an error if you try to delete a file that does not exist. */ @@ -5722,8 +6573,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; }; @@ -5746,7 +6597,12 @@ export interface paths { * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -5794,7 +6650,7 @@ export interface paths { "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { /** * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; }; @@ -5803,7 +6659,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; }; @@ -5812,7 +6669,7 @@ export interface paths { * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; }; @@ -5834,12 +6691,10 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5849,12 +6704,12 @@ export interface paths { get: operations["issues/list-for-repo"]; /** * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.9/articles/disabling-issues/), the API returns a `410 Gone` status. + * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.15/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5870,7 +6725,7 @@ export interface paths { * * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5884,7 +6739,7 @@ export interface paths { * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5901,7 +6756,7 @@ export interface paths { * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5913,21 +6768,22 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). + * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; }; @@ -5948,19 +6804,17 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}": { /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + * [transferred](https://docs.github.com/enterprise-server@3.15/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - * to the [`issues`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#issues) webhook. + * to the [`issues`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -5970,9 +6824,9 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6011,7 +6865,7 @@ export interface paths { * * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6023,12 +6877,12 @@ export interface paths { * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6078,7 +6932,7 @@ export interface paths { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; /** @@ -6090,21 +6944,22 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). + * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; }; @@ -6190,7 +7045,7 @@ export interface paths { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -6249,7 +7104,7 @@ export interface paths { get: operations["activity/list-repo-notifications-for-authenticated-user"]; /** * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; }; @@ -6332,6 +7187,24 @@ export interface paths { */ post: operations["repos/create-pages-deployment"]; }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + get: operations["repos/get-pages-deployment"]; + }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + post: operations["repos/cancel-pages-deployment"]; + }; "/repos/{owner}/{repo}/pre-receive-hooks": { /** * List pre-receive hooks for a repository @@ -6367,6 +7240,22 @@ 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 read access to the repository can use this endpoint. + */ + get: operations["repos/get-custom-properties-values"]; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + patch: operations["repos/create-or-update-custom-properties-values"]; + }; "/repos/{owner}/{repo}/pulls": { /** * List pull requests @@ -6375,10 +7264,10 @@ export interface paths { * 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-server@3.9/github/getting-started-with-github/githubs-products) + * Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6388,13 +7277,13 @@ export interface paths { get: operations["pulls/list"]; /** * Create a pull request - * @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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6409,7 +7298,7 @@ export interface paths { * @description Lists review comments for all pull requests in a repository. By default, * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6423,7 +7312,7 @@ export interface paths { * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6440,7 +7329,7 @@ export interface paths { * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6452,44 +7341,45 @@ 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/rest/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.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** * Create reaction for a pull request review comment - * @description Create a reaction 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). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction 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). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { /** * Get a pull request - * @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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6500,11 +7390,11 @@ export interface paths { get: operations["pulls/get"]; /** * Update a pull request - * @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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6519,7 +7409,7 @@ export interface paths { * @description Lists all review comments for a specified pull request. By default, review comments * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6529,16 +7419,16 @@ export interface paths { get: operations["pulls/list-review-comments"]; /** * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment)." + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#create-an-issue-comment)." * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6552,10 +7442,10 @@ export interface paths { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6568,10 +7458,10 @@ export interface paths { /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits) + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-commits) * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6585,10 +7475,10 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6606,14 +7496,14 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { /** * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; /** @@ -6632,7 +7522,7 @@ export interface paths { * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6644,15 +7534,16 @@ export interface paths { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6666,7 +7557,7 @@ export interface paths { * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6678,7 +7569,7 @@ export interface paths { * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6690,7 +7581,7 @@ export interface paths { * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6704,7 +7595,7 @@ export interface paths { * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6718,11 +7609,10 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6734,9 +7624,9 @@ export interface paths { "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -6749,6 +7639,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -6757,7 +7648,7 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -6769,7 +7660,7 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -6779,7 +7670,7 @@ export interface paths { "/repos/{owner}/{repo}/releases": { /** * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-tags). + * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ @@ -6788,14 +7679,20 @@ export interface paths { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; /** Delete a release asset */ @@ -6809,7 +7706,7 @@ export interface paths { "/repos/{owner}/{repo}/releases/generate-notes": { /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; }; @@ -6834,9 +7731,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; /** @@ -6855,8 +7751,8 @@ export interface paths { get: operations["repos/list-release-assets"]; /** * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release) to upload a release asset. + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * @@ -6870,9 +7766,9 @@ export interface paths { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets)" + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.15/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; @@ -6880,21 +7776,22 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions": { /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). + * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; }; @@ -6905,6 +7802,64 @@ export interface paths { */ get: operations["repos/list-cache-info"]; }; + "/repos/{owner}/{repo}/rules/branches/{branch}": { + /** + * Get rules for a branch + * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. + */ + get: operations["repos/get-branch-rules"]; + }; + "/repos/{owner}/{repo}/rulesets": { + /** + * Get all repository rulesets + * @description Get all the rulesets for a repository. + */ + get: operations["repos/get-repo-rulesets"]; + /** + * Create a repository ruleset + * @description Create a ruleset for a repository. + */ + 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-server@3.15/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-server@3.15/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 + * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + get: operations["repos/get-repo-ruleset"]; + /** + * Update a repository ruleset + * @description Update a ruleset for a repository. + */ + put: operations["repos/update-repo-ruleset"]; + /** + * Delete a repository ruleset + * @description Delete a ruleset for a repository. + */ + delete: operations["repos/delete-repo-ruleset"]; + }; "/repos/{owner}/{repo}/secret-scanning/alerts": { /** * List secret scanning alerts for a repository @@ -6947,12 +7902,23 @@ export interface paths { */ get: operations["secret-scanning/list-locations-for-alert"]; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + }; "/repos/{owner}/{repo}/stargazers": { /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -7033,12 +7999,12 @@ export interface paths { get: operations["activity/get-repo-subscription"]; /** * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription) completely. + * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; /** * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription). + * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; }; @@ -7048,23 +8014,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -7075,7 +8053,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -7099,27 +8079,26 @@ export interface paths { "/repos/{owner}/{repo}/transfer": { /** * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/). - * You must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account. + * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.15/articles/about-repository-transfers/). */ post: operations["repos/transfer"]; }; "/repos/{owner}/{repo}/vulnerability-alerts": { /** * Check if vulnerability alerts are enabled for a repository - * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". */ get: operations["repos/check-vulnerability-alerts"]; /** * Enable vulnerability alerts - * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". */ put: operations["repos/enable-vulnerability-alerts"]; /** * Disable vulnerability alerts * @description Disables dependency alerts for a repository. * The authenticated user must have admin access to the repository. For more information, - * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". */ delete: operations["repos/disable-vulnerability-alerts"]; }; @@ -7130,14 +8109,15 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; }; "/repos/{template_owner}/{template_repo}/generate": { /** * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ @@ -7150,14 +8130,15 @@ export interface paths { * * Note: * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; }; "/scim/v2/enterprises/{enterprise}/Groups": { /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -7166,7 +8147,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -7177,14 +8159,16 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -7193,14 +8177,16 @@ export interface paths { put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -7213,7 +8199,8 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users": { /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -7222,7 +8209,8 @@ export interface paths { get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -7235,59 +8223,66 @@ export interface paths { "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; }; "/search/code": { /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -7309,10 +8304,10 @@ export interface paths { "/search/commits": { /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -7323,10 +8318,10 @@ export interface paths { "/search/issues": { /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -7334,16 +8329,17 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.15/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; }; "/search/labels": { /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -7356,9 +8352,9 @@ export interface paths { "/search/repositories": { /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -7371,9 +8367,9 @@ export interface paths { "/search/topics": { /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.9/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.15/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -7386,9 +8382,9 @@ export interface paths { "/search/users": { /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -7396,116 +8392,23 @@ export interface paths { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.15/graphql/reference/queries#search)." */ get: operations["search/users"]; }; - "/setup/api/configcheck": { - /** - * Get the configuration status - * @description This endpoint allows you to check the status of the most recent configuration process: - * - * Note that you may need to wait several seconds after you start a process before you can check its status. - * - * The different statuses are: - * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | - */ - get: operations["enterprise-admin/get-configuration-status"]; - }; - "/setup/api/configure": { - /** - * Start a configuration process - * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: - */ - post: operations["enterprise-admin/start-configuration-process"]; - }; - "/setup/api/maintenance": { - /** - * Get the maintenance status - * @description Check your installation's maintenance status: - */ - get: operations["enterprise-admin/get-maintenance-status"]; - /** - * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ - post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; - }; - "/setup/api/settings": { - /** - * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings). - * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. - */ - get: operations["enterprise-admin/get-settings"]; - /** - * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). - * - * **Notes:** - * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." - */ - put: operations["enterprise-admin/set-settings"]; - }; - "/setup/api/settings/authorized-keys": { - /** Get all authorized SSH keys */ - get: operations["enterprise-admin/get-all-authorized-ssh-keys"]; - /** - * Add an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ - post: operations["enterprise-admin/add-authorized-ssh-key"]; - /** - * Remove an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ - delete: operations["enterprise-admin/remove-authorized-ssh-key"]; - }; - "/setup/api/start": { - /** - * Create a GitHub license - * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. - * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. - * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: - * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ - post: operations["enterprise-admin/create-enterprise-server-license"]; - }; - "/setup/api/upgrade": { - /** - * Upgrade a license - * @description This API upgrades your license and also triggers the configuration process. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ - post: operations["enterprise-admin/upgrade-license"]; - }; "/teams/{team_id}": { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -7515,11 +8418,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -7527,7 +8432,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -7537,11 +8443,12 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7551,7 +8458,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -7561,7 +8469,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -7571,7 +8480,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -7583,7 +8493,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -7593,11 +8504,12 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7607,7 +8519,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -7617,7 +8530,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -7627,7 +8541,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -7639,9 +8554,10 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -7649,9 +8565,10 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * @@ -7663,9 +8580,10 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -7673,9 +8591,10 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * @@ -7687,7 +8606,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.15/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -7697,9 +8617,9 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. */ @@ -7707,31 +8627,33 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; }; @@ -7739,7 +8661,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -7748,19 +8671,21 @@ export interface paths { * **Note:** * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -7770,13 +8695,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; }; @@ -7784,7 +8711,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -7794,7 +8722,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -7802,7 +8731,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -7810,7 +8740,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -7820,7 +8751,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; }; @@ -7828,27 +8760,31 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -7858,7 +8794,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; }; @@ -7922,7 +8859,7 @@ export interface paths { get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ @@ -7991,13 +8928,15 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. + * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -8006,12 +8945,10 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -8123,6 +9060,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -8131,7 +9071,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; }; @@ -8140,14 +9080,14 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; /** * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; }; @@ -8160,7 +9100,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; }; @@ -8169,7 +9109,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; }; @@ -8178,7 +9118,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; /** @@ -8187,7 +9127,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; }; @@ -8200,7 +9140,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; }; @@ -8215,7 +9155,7 @@ export interface paths { /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) * endpoint. * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -8309,7 +9249,7 @@ export interface paths { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -8323,7 +9263,7 @@ export interface paths { get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; /** @@ -8351,12 +9291,23 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.15/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; }; @@ -8365,9 +9316,9 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.9/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.15/rest/users/emails)". */ get: operations["users/get-by-username"]; }; @@ -8383,7 +9334,10 @@ export interface paths { "/users/{username}/events": { /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; }; @@ -8391,11 +9345,18 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; }; "/users/{username}/followers": { @@ -8446,7 +9407,7 @@ export interface paths { * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; }; @@ -8460,9 +9421,9 @@ export interface paths { "/users/{username}/orgs": { /** * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership) for the specified user. + * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.15/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; }; @@ -8471,7 +9432,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; }; @@ -8480,16 +9441,16 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; /** * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; }; @@ -8502,9 +9463,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; }; @@ -8513,7 +9474,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; }; @@ -8522,16 +9483,16 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; /** * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; }; @@ -8544,9 +9505,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; }; @@ -8560,12 +9521,20 @@ export interface paths { "/users/{username}/received_events": { /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -8578,7 +9547,7 @@ export interface paths { "/users/{username}/site_admin": { /** * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/promote-user-to-be-site-administrator"]; /** @@ -8606,7 +9575,7 @@ export interface paths { * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -8622,16 +9591,16 @@ export interface paths { "/users/{username}/suspended": { /** * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * * You can suspend any user account except your own. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/suspend-user"]; /** * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ delete: operations["enterprise-admin/unsuspend-user"]; }; @@ -8799,9 +9768,11 @@ export interface components { ping_url?: string; }; "public-key-full": { + /** Format: int64 */ id: number; key: string; user_id: number | null; + /** Format: int64 */ repository_id: number | null; url: string; title: string; @@ -8823,6 +9794,7 @@ export interface components { slug?: string; description?: string | null; privacy?: string; + notification_setting?: string; permission?: string; members_url?: string; repositories_url?: string; @@ -8836,7 +9808,10 @@ export interface components { ldap_dn?: string; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -8950,6 +9925,8 @@ export interface components { /** Format: date-time */ suspended_at?: string | null; business_plus?: boolean; + /** @example public */ + user_view_type?: string; }; /** * Organization Simple @@ -8991,6 +9968,7 @@ export interface components { description: string | null; }; "pre-receive-environment": { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9024,6 +10002,7 @@ export interface components { html_url?: string; }; environment?: { + /** Format: int64 */ id?: number; name?: string; image_url?: string; @@ -9050,7 +10029,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9109,6 +10091,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * App Permissions @@ -9186,6 +10170,11 @@ export interface components { * @enum {string} */ pull_requests?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + * @enum {string} + */ + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} @@ -9247,7 +10236,17 @@ export interface components { */ organization_custom_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for custom organization roles management. + * @enum {string} + */ + organization_custom_org_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom property management. + * @enum {string} + */ + organization_custom_properties?: "read" | "write" | "admin"; + /** + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -9282,7 +10281,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -9346,6 +10345,11 @@ export interface components { * @enum {string} */ starring?: "read" | "write"; + /** + * @description The level of permission to grant the access token to list and manage repositories a user is starring. + * @enum {string} + */ + enterprise_administration?: "read" | "write"; }; /** * Simple User @@ -9356,7 +10360,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9415,6 +10422,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** Scoped Installation */ "nullable-scoped-installation": { @@ -9447,6 +10456,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -9474,6 +10484,191 @@ export interface components { /** Format: date-time */ expires_at: string | null; }; + /** + * @description The package's language or package management ecosystem. + * @enum {string} + */ + "security-advisory-ecosystems": + | "rubygems" + | "npm" + | "pip" + | "maven" + | "nuget" + | "composer" + | "go" + | "rust" + | "erlang" + | "actions" + | "pub" + | "other" + | "swift"; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + vulnerable_functions: readonly string[] | null; + }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; + /** + * @description The type of credit the user is receiving. + * @enum {string} + */ + "security-advisory-credit-types": + | "analyst" + | "finder" + | "reporter" + | "coordinator" + | "remediation_developer" + | "remediation_reviewer" + | "remediation_verifier" + | "tool" + | "sponsor" + | "other"; + /** @description A GitHub Security Advisory. */ + "global-advisory": { + /** @description The GitHub Security Advisory ID. */ + ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + cve_id: string | null; + /** @description The API URL for the advisory. */ + url: string; + /** + * Format: uri + * @description The URL for the advisory. + */ + html_url: string; + /** + * Format: uri + * @description The API URL for the repository advisory. + */ + repository_advisory_url: string | null; + /** @description A short summary of the advisory. */ + summary: string; + /** @description A detailed description of what the advisory entails. */ + description: string | null; + /** + * @description The type of advisory. + * @enum {string} + */ + type: "reviewed" | "unreviewed" | "malware"; + /** + * @description The severity of the advisory. + * @enum {string} + */ + severity: "critical" | "high" | "medium" | "low" | "unknown"; + /** + * Format: uri + * @description The URL of the advisory's source code. + */ + source_code_location: string | null; + identifiers: + | readonly { + /** + * @description The type of identifier. + * @enum {string} + */ + type: "CVE" | "GHSA"; + /** @description The identifier value. */ + value: string; + }[] + | null; + references: string[] | null; + /** + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. + */ + published_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. + */ + updated_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + */ + github_reviewed_at: string | null; + /** + * Format: date-time + * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. + */ + nvd_published_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + withdrawn_at: string | null; + /** @description The products and respective version ranges affected by the advisory. */ + vulnerabilities: components["schemas"]["vulnerability"][] | null; + cvss: { + /** @description The CVSS vector. */ + vector_string: string | null; + /** @description The CVSS score. */ + score: number | null; + } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; + cwes: + | { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + cwe_id: string; + /** @description The name of the CWE. */ + name: string; + }[] + | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; + /** @description In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available. */ + credits: + | readonly { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; + }[] + | null; + }; + /** + * Basic Error + * @description Basic Error + */ + "basic-error": { + message?: string; + documentation_url?: string; + url?: string; + status?: string; + }; + /** + * Validation Error Simple + * @description Validation Error Simple + */ + "validation-error-simple": { + message: string; + documentation_url: string; + errors?: string[]; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -9491,6 +10686,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -9547,8 +10744,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -9556,25 +10751,6 @@ export interface components { /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; } | null; - /** - * Basic Error - * @description Basic Error - */ - "basic-error": { - message?: string; - documentation_url?: string; - url?: string; - status?: string; - }; - /** - * Validation Error Simple - * @description Validation Error Simple - */ - "validation-error-simple": { - message: string; - documentation_url: string; - errors?: string[]; - }; /** * Format: uri * @description The URL to which the payloads will be delivered. @@ -9587,7 +10763,7 @@ export interface components { */ "webhook-config-content-type": string; /** - * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers). + * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers). * @example "********" */ "webhook-config-secret": string; @@ -9663,6 +10839,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -9753,6 +10935,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -9940,6 +11128,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -10231,7 +11420,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10318,7 +11507,10 @@ export interface components { * @description The authorization associated with an OAuth Access. */ "application-grant": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * Format: uri @@ -10415,7 +11607,7 @@ export interface components { html_url: string | null; }; /** - * @description The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.9/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + * @description The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.15/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." * @example Very **important** announcement about _something_. */ "announcement-message": string | null; @@ -10517,6 +11709,24 @@ export interface components { gists?: components["schemas"]["enterprise-gist-overview"]; comments?: components["schemas"]["enterprise-comment-overview"]; }; + /** Enterprise Security Products Stats */ + "enterprise-security-products-overview": { + total_repos?: number; + nonarchived_repos?: number; + secret_scanning_enabled_repos?: number; + secret_scanning_push_protection_enabled_repos?: number; + code_scanning_enabled_repos?: number; + code_scanning_pr_reviews_enabled_repos?: number; + code_scanning_default_setup_enabled_repos?: number; + code_scanning_default_setup_eligible_repos?: number; + dependabot_alerts_enabled_repos?: number; + dependabot_security_updates_enabled_repos?: number; + dependabot_version_updates_enabled_repos?: number; + advanced_security_enabled_repos?: number; + active_committers?: number; + purchased_committers?: number; + maximum_committers?: number; + }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ total_active_caches_count: number; @@ -10798,9 +12008,9 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -10816,10 +12026,10 @@ export interface components { * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -10827,8 +12037,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -10841,6 +12049,8 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -10902,6 +12112,7 @@ export interface components { */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -11163,6 +12374,11 @@ export interface components { * @example false */ advanced_security_enabled_for_new_repositories: boolean; + /** + * @description Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. + * @example false + */ + advanced_security_enabled_for_new_user_namespace_repositories?: boolean; /** * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this * enterprise. @@ -11186,6 +12402,11 @@ export interface components { * @example https://github.com/test-org/test-repo/blob/main/README.md */ secret_scanning_push_protection_custom_link?: string | null; + /** + * @description Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise. + * @example false + */ + secret_scanning_non_provider_patterns_enabled_for_new_repositories?: boolean; }; /** @description Details for the vulnerable package. */ readonly "dependabot-alert-package": { @@ -11234,6 +12455,7 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -11367,7 +12589,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -11383,11 +12605,18 @@ export interface components { push_protection_bypassed_at?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; "advanced-security-active-committers-user": { user_login: string; /** @example 2021-11-03 */ last_pushed_date: string; + /** @example monalisa@github.com */ + last_pushed_email: string; }; "advanced-security-active-committers-repository": { /** @example octocat/Hello-World */ @@ -11401,6 +12630,16 @@ export interface components { total_advanced_security_committers?: number; /** @example 2 */ total_count?: number; + /** + * @description The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security + * @example 4 + */ + maximum_advanced_security_committers?: number; + /** + * @description The total number of GitHub Advanced Security licences purchased + * @example 4 + */ + purchased_advanced_security_committers?: number; repositories: components["schemas"]["advanced-security-active-committers-repository"][]; }; /** @@ -11503,6 +12742,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -11559,8 +12800,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -11597,6 +12836,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -11704,6 +12949,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -11863,6 +13109,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -11886,7 +13137,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -11917,6 +13170,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -11934,8 +13189,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -12044,6 +13297,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -12239,6 +13497,158 @@ export interface components { /** @example true */ featured: boolean; }; + "ghes-get-ssh": { + /** + * Format: ssh-key + * @description The full public key + */ + key?: string; + /** + * Format: ssh-key fingerprint + * @description The fingerprint of the key + */ + fingerprint?: string; + }[]; + /** Set SSH key */ + "ghes-set-ssh-request": { + /** @description The public SSH key to add to the `authorized_keys` file. */ + key: string; + }; + "ghes-set-ssh-response": { + /** + * Format: hostname + * @description Hostname of the node where the SSH key was added. + */ + hostname?: string; + /** + * Format: uuid + * @description UUID of the SSH key that was added. + */ + uuid?: string; + /** @description Message indicating the result of the SSH key addition. */ + message?: string; + /** @description Error message indicating the reason for the SSH key addition failure. This field is only present if the SSH key addition failed. */ + error?: string; + /** @description Whether the SSH key was already present on the `authorized_keys` file. */ + modified?: boolean; + }[]; + /** Set SSH key */ + "ghes-delete-ssh-request": { + /** @description The public SSH key to remove from the `authorized_keys` file. */ + key: string; + }; + "ghes-delete-ssh-response": { + /** + * Format: hostname + * @description Hostname of the node where the SSH key was removed. + */ + hostname?: string; + /** + * Format: uuid + * @description UUID of the SSH key that was removed. + */ + uuid?: string; + /** @description Message indicating the result of the SSH key removal. */ + message?: string; + /** @description Error message indicating the reason for the SSH key removal failure. This field is only present if the SSH key removal failed. */ + error?: string; + }[]; + /** @enum {string} */ + "ghes-checks-result-indicator": "OK" | "FAILED"; + "ghes-checks-system-requirements": { + status?: components["schemas"]["ghes-checks-result-indicator"]; + nodes?: { + hostname?: string; + status?: components["schemas"]["ghes-checks-result-indicator"]; + roles_status?: { + status?: components["schemas"]["ghes-checks-result-indicator"]; + role?: string; + }[]; + }[]; + }; + /** @enum {string} */ + "ghes-cluster-status-indicator": "UNKNOWN" | "OK" | "WARNING" | "CRITICAL"; + "ghes-cluster-status": { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + nodes?: { + hostname?: string; + status?: components["schemas"]["ghes-cluster-status-indicator"]; + services?: { + status?: components["schemas"]["ghes-cluster-status-indicator"]; + name?: string; + details?: string; + }[]; + }[]; + }; + /** Initialize configuration with license upload */ + "ghes-config-init-request": { + /** @description The content of your _.ghl_ license file. */ + license: string; + /** @description The root site administrator password. */ + password: string; + }; + "ghes-license-info": { + /** @description Whether the GitHub Advanced Security feature is enabled. */ + advancedSecurityEnabled?: boolean; + /** @description If the GitHub Advanced Security feature is enabled, the seat count. */ + advancedSecuritySeats?: number; + /** @description Whether the cluster support feature is enabled. */ + clusterSupport?: boolean; + /** @description The company under which the license is issued. */ + company?: string; + /** @description Whether the Github Connect feature is enabled. */ + croquetSupport?: boolean; + /** @description Whether this license is issued under custom terms. */ + customTerms?: boolean; + /** @description Wheter this license is issued as an evaluation license. */ + evaluation?: boolean; + /** + * Format: date-time + * @description The expiration date of the license. + * @example 2025-01-02T07:59:59Z + */ + expireAt?: string; + /** @description Whether the insights feature is enabled. */ + insightsEnabled?: boolean; + /** + * Format: date-time + * @description If the insights feature is enabled, the expiration date. + * @example 2025-01-02T07:59:59Z + */ + insightsExpireAt?: string; + /** + * Format: date-time + * @description If the learning lab feature is enabled, the expiration date. + * @example 2025-01-02T07:59:59Z + */ + learningLabEvaluationExpires?: string; + /** @description If the learning lab feature is enabled, the seat count. */ + learningLabSeats?: number; + /** @description Whether the perpetual feature is enabled. */ + perpetual?: boolean; + /** @description The unique reference number of the license. */ + referenceNumber?: string; + /** @description If the license is issued with limited seating, the seat count. */ + seats?: number; + /** @description Whether the SSH feature is enabled. */ + sshAllowed?: boolean; + /** @description The support key of the license. */ + supportKey?: string; + /** @description Whether the license is issued with unlimited seat count. */ + unlimitedSeating?: boolean; + }; + /** License upload form */ + "ghes-upload-license-request": { + /** @description The content of your _.ghl_ license file. */ + license: string; + }; + "ghes-license-check": { + /** + * @description The license status of the currently active enterprise license. + * @enum {string} + */ + status?: "valid" | "invalid" | "expired" | "cluster mode not supported"; + }; /** @enum {string} */ "ghes-cluster-topology": "SingleNode" | "Ha" | "Cluster"; /** @enum {string} */ @@ -12267,6 +13677,189 @@ export interface components { cluster_roles?: components["schemas"]["ghes-cluster-roles"][]; }[]; }; + "ghes-get-settings": { + private_mode?: boolean; + public_pages?: boolean; + subdomain_isolation?: boolean; + signup_enabled?: boolean; + github_hostname?: string; + identicons_host?: string; + http_proxy?: string | null; + auth_mode?: string; + expire_sessions?: boolean; + admin_password?: string | null; + configuration_id?: number; + configuration_run_count?: number; + avatar?: { + enabled?: boolean; + uri?: string; + }; + customer?: { + name?: string; + email?: string; + uuid?: string; + secret_key_data?: string; + public_key_data?: string; + }; + license?: { + seats?: number; + evaluation?: boolean; + perpetual?: boolean; + unlimited_seating?: boolean; + support_key?: string; + ssh_allowed?: boolean; + cluster_support?: boolean; + expire_at?: string; + }; + github_ssl?: { + enabled?: boolean; + cert?: string | null; + key?: string | null; + }; + ldap?: { + host?: string | null; + port?: number; + base?: string[]; + uid?: string | null; + bind_dn?: string | null; + password?: string | null; + method?: string; + search_strategy?: string; + user_groups?: string[]; + admin_group?: string | null; + virtual_attribute_enabled?: boolean; + recursive_group_search?: boolean; + posix_support?: boolean; + user_sync_emails?: boolean; + user_sync_keys?: boolean; + user_sync_interval?: number; + team_sync_interval?: number; + sync_enabled?: boolean; + reconciliation?: { + user?: string | null; + org?: string | null; + }; + profile?: { + uid?: string; + name?: string | null; + mail?: string | null; + key?: string | null; + }; + }; + cas?: { + url?: string | null; + }; + saml?: { + sso_url?: string | null; + certificate?: string | null; + certificate_path?: string | null; + issuer?: string | null; + idp_initiated_sso?: boolean; + disable_admin_demote?: boolean; + }; + github_oauth?: { + client_id?: string; + client_secret?: string; + organization_name?: string; + organization_team?: string; + }; + smtp?: { + enabled?: boolean; + address?: string; + authentication?: string; + port?: string; + domain?: string; + username?: string; + user_name?: string; + enable_starttls_auto?: boolean; + password?: string; + "discard-to-noreply-address"?: boolean; + support_address?: string; + support_address_type?: string; + noreply_address?: string; + }; + ntp?: { + primary_server?: string; + secondary_server?: string; + }; + timezone?: string | null; + snmp?: { + enabled?: boolean; + community?: string; + }; + syslog?: { + enabled?: boolean; + server?: string | null; + protocol_name?: string; + }; + assets?: string | null; + pages?: { + enabled?: boolean; + }; + collectd?: { + enabled?: boolean; + server?: string | null; + port?: number; + encryption?: string | null; + username?: string | null; + password?: string | null; + }; + mapping?: { + enabled?: boolean; + tileserver?: string | null; + basemap?: string; + token?: string | null; + }; + load_balancer?: string | null; + }; + "ghes-get-maintenance": { + /** Format: hostname */ + hostname?: string; + /** Format: uuid */ + uuid?: string; + /** @enum {string} */ + status?: "on" | "off" | "scheduled"; + /** Format: date */ + scheduled_time?: string; + connection_services?: { + name?: string; + number?: number; + }[]; + can_unset_maintenance?: boolean; + ip_exception_list?: string[]; + maintenance_mode_message?: string; + }[]; + /** Set Maintenance mode */ + "ghes-set-maintenance-request": { + /** @description Whether to enable maintenance mode. */ + enabled: boolean; + /** + * Format: uuid + * @description The UUID of the node to target. This parameter is incompatible with maintenance mode scheduling. Only use `uuid` if the value of `when` is empty or `now`. + */ + uuid?: string; + /** + * Format: date-time + * @description The time to enable maintenance mode. If this parameter is empty or set to `now`, maintenance mode is enabled immediately. Otherwise, maintenance mode is enabled at the specified time. The format is ISO 8601. + * @example 2006-01-02T15:04:05+00:00 + */ + when?: string; + /** + * @description The list of IP addresses to exclude from maintenance mode. IPv4, IPv6, and CIDR addresses are supported. + * @example ["1.1.1.1","192.168.1.0/24"] + */ + ip_exception_list?: string[]; + /** @description The message to display to users when maintenance mode is enabled. */ + maintenance_mode_message?: string; + }; + "ghes-set-maintenance-response": { + /** Format: hostname */ + hostname?: string; + /** Format: uuid */ + uuid?: string; + message?: string; + error?: string; + }[]; /** @enum {string} */ "ghes-replication-status-indicator": | "UNKNOWN" @@ -12310,20 +13903,27 @@ export interface components { * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ - dependabot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; - /** @example 3.9.0 */ + /** @example 3.15.0 */ installed_version?: string; }; "security-and-analysis": { @@ -12331,6 +13931,14 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + /** @description Enable or disable Dependabot security updates for the repository. */ + dependabot_security_updates?: { + /** + * @description The enablement status of Dependabot security updates for the repository. + * @enum {string} + */ + status?: "enabled" | "disabled"; + }; secret_scanning?: { /** @enum {string} */ status?: "enabled" | "disabled"; @@ -12339,13 +13947,20 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -12711,7 +14326,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -12749,47 +14369,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -12812,6 +14445,8 @@ export interface components { created_at: string; /** Format: date-time */ updated_at: string; + /** Format: date-time */ + archived_at: string | null; }; /** * Actions Cache Usage by repository @@ -12997,6 +14632,131 @@ export interface components { | "warning" | "note" | "error"; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** + * @description The type of the code security configuration. + * @enum {string} + */ + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; "organization-custom-repository-role-create-schema": { /** @description The name of the custom role. */ name: string; @@ -13069,7 +14829,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -13538,7 +15301,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -13576,6 +15342,321 @@ export interface components { /** @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"`. */ exclude?: string[]; }; + /** + * Organization Fine-Grained Permission + * @description A fine-grained permission that protects organization resources. + */ + "organization-fine-grained-permission": { + name: string; + description: string; + }; + /** + * Organization Role + * @description Organization roles + */ + "organization-role": { + /** + * Format: int64 + * @description The unique identifier of the role. + */ + id: number; + /** @description The name of the role. */ + name: string; + /** @description A short description about who this role is for or what permissions it grants. */ + description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; + /** @description A list of permissions included in this role. */ + permissions: string[]; + organization: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The date and time the role was created. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the role was last updated. + */ + updated_at: string; + }; + "organization-custom-organization-role-create-schema": { + /** @description The name of the custom role. */ + name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions: string[]; + /** + * @description The system role from which this role can inherit permissions. + * @enum {string} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin"; + }; + "organization-custom-organization-role-update-schema": { + /** @description The name of the custom role. */ + name?: string; + /** @description A short description about the intended use of this role or the permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions?: string[]; + /** + * @description The system role from which this role can inherit permissions. + * @enum {string} + */ + base_role?: "none" | "read" | "triage" | "write" | "maintain" | "admin"; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + } | null; + /** + * A Role Assignment for a Team + * @description The Relationship a Team has with a role. + */ + "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + }; + /** + * A Role Assignment for a User + * @description The Relationship a User has with a role. + */ + "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** @example 1 */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + }; /** * Package Version * @description A version of a software package @@ -13638,6 +15719,88 @@ export interface components { }; }; }; + /** + * Simple Organization Programmatic Access Grant Request + * @description Minimal representation of an organization programmatic access grant request for enumerations + */ + "organization-programmatic-access-grant-request": { + /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ + id: number; + /** @description Reason for requesting access. */ + reason: string | null; + owner: components["schemas"]["simple-user"]; + /** + * @description Type of repository selection requested. + * @enum {string} + */ + repository_selection: "none" | "all" | "subset"; + /** @description URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`. */ + repositories_url: string; + /** @description Permissions requested, categorized by type of permission. */ + permissions: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** @description Date and time when the request for access was created. */ + created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; + /** @description Whether the associated fine-grained personal access token has expired. */ + token_expired: boolean; + /** @description Date and time when the associated fine-grained personal access token expires. */ + token_expires_at: string | null; + /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + token_last_used_at: string | null; + }; + /** + * Organization Programmatic Access Grant + * @description Minimal representation of an organization programmatic access grant for enumerations + */ + "organization-programmatic-access-grant": { + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ + id: number; + owner: components["schemas"]["simple-user"]; + /** + * @description Type of repository selection requested. + * @enum {string} + */ + repository_selection: "none" | "all" | "subset"; + /** @description URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`. */ + repositories_url: string; + /** @description Permissions requested, categorized by type of permission. */ + permissions: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ + access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; + /** @description Whether the associated fine-grained personal access token has expired. */ + token_expired: boolean; + /** @description Date and time when the associated fine-grained personal access token expires. */ + token_expires_at: string | null; + /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + token_last_used_at: string | null; + }; "org-pre-receive-hook": { id?: number; name?: string; @@ -13710,12 +15873,102 @@ 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 + */ + "custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + 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 | 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"][]; + }; /** * Repository * @description A repository on GitHub. */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -14007,7 +16260,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -14091,7 +16344,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14391,6 +16647,10 @@ export interface components { anonymous_access_enabled?: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Repository Fine-Grained Permission @@ -14401,121 +16661,606 @@ export interface components { description: string; }; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * @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 not available for the `repository` target. + * @enum {string} */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + /** + * Repository Ruleset Bypass Actor + * @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. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + actor_id?: number | null; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The type of actor that can bypass a ruleset + * @enum {string} */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + actor_type: + | "Integration" + | "OrganizationAdmin" + | "RepositoryRole" + | "Team" + | "DeployKey"; /** - * @description Name of the team - * @example Justice League + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always + * @enum {string} */ + bypass_mode?: "always" | "pull_request"; + }; + /** + * Repository ruleset conditions for ref names + * @description Parameters for a repository ruleset ref name condition + */ + "repository-ruleset-conditions": { + ref_name?: { + /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ + include?: string[]; + /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + }; + }; + /** + * Repository ruleset conditions for repository names + * @description Parameters for a repository name condition + */ + "repository-ruleset-conditions-repository-name-target": { + repository_name: { + /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ + include?: string[]; + /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + /** @description Whether renaming of target repositories is prevented. */ + protected?: boolean; + }; + }; + /** + * Repository ruleset conditions for repository IDs + * @description Parameters for a repository ID condition + */ + "repository-ruleset-conditions-repository-id-target": { + repository_id: { + /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ + repository_ids?: number[]; + }; + }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ name: string; + /** @description The values to match for the repository property */ + property_values: string[]; /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} */ - html_url: string; + source?: "custom" | "system"; + }; + /** + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition + */ + "repository-ruleset-conditions-repository-property-target": { + repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; + }; + /** + * Organization ruleset conditions + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. + */ + "org-ruleset-conditions": + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-name-target"]) + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-id-target"]) + | (components["schemas"]["repository-ruleset-conditions"] & + components["schemas"]["repository-ruleset-conditions-repository-property-target"]); + /** + * creation + * @description Only allow users with bypass permission to create matching refs. + */ + "repository-rule-creation": { + /** @enum {string} */ + type: "creation"; + }; + /** + * update + * @description Only allow users with bypass permission to update matching refs. + */ + "repository-rule-update": { + /** @enum {string} */ + type: "update"; + parameters?: { + /** @description Branch can pull changes from its upstream repository */ + update_allows_fetch_and_merge: boolean; + }; + }; + /** + * deletion + * @description Only allow users with bypass permissions to delete matching refs. + */ + "repository-rule-deletion": { + /** @enum {string} */ + type: "deletion"; + }; + /** + * required_linear_history + * @description Prevent merge commits from being pushed to matching refs. + */ + "repository-rule-required-linear-history": { + /** @enum {string} */ + type: "required_linear_history"; + }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; + /** + * required_deployments + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. + */ + "repository-rule-required-deployments": { + /** @enum {string} */ + type: "required_deployments"; + parameters?: { + /** @description The environments that must be successfully deployed to before branches can be merged. */ + required_deployment_environments: string[]; + }; + }; + /** + * required_signatures + * @description Commits pushed to matching refs must have verified signatures. + */ + "repository-rule-required-signatures": { + /** @enum {string} */ + type: "required_signatures"; + }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; + /** + * pull_request + * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. + */ + "repository-rule-pull-request": { + /** @enum {string} */ + type: "pull_request"; + parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; + /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ + dismiss_stale_reviews_on_push: boolean; + /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ + require_code_owner_review: boolean; + /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ + require_last_push_approval: boolean; + /** @description The number of approving reviews that are required before a pull request can be merged. */ + required_approving_review_count: number; + /** @description All conversations on code must be resolved before a pull request can be merged. */ + required_review_thread_resolution: boolean; + }; + }; + /** + * StatusCheckConfiguration + * @description Required status check + */ + "repository-rule-params-status-check-configuration": { + /** @description The status check context name that must be present on the commit. */ + context: string; + /** @description The optional integration ID that this status check must originate from. */ + integration_id?: number; + }; + /** + * required_status_checks + * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. + */ + "repository-rule-required-status-checks": { + /** @enum {string} */ + type: "required_status_checks"; + parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; + /** @description Status checks that are required. */ + required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; + /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ + strict_required_status_checks_policy: boolean; + }; + }; + /** + * non_fast_forward + * @description Prevent users with push access from force pushing to refs. + */ + "repository-rule-non-fast-forward": { + /** @enum {string} */ + type: "non_fast_forward"; + }; + /** + * commit_message_pattern + * @description Parameters to be used for the commit_message_pattern rule + */ + "repository-rule-commit-message-pattern": { + /** @enum {string} */ + type: "commit_message_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * commit_author_email_pattern + * @description Parameters to be used for the commit_author_email_pattern rule + */ + "repository-rule-commit-author-email-pattern": { + /** @enum {string} */ + type: "commit_author_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * committer_email_pattern + * @description Parameters to be used for the committer_email_pattern rule + */ + "repository-rule-committer-email-pattern": { + /** @enum {string} */ + type: "committer_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * branch_name_pattern + * @description Parameters to be used for the branch_name_pattern rule + */ + "repository-rule-branch-name-pattern": { + /** @enum {string} */ + type: "branch_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * tag_name_pattern + * @description Parameters to be used for the tag_name_pattern rule + */ + "repository-rule-tag-name-pattern": { + /** @enum {string} */ + type: "tag_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + 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 Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; + /** + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. + */ + "repository-rule-params-code-scanning-tool": { /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - repositories_url: string; - /** @example justice-league */ - slug: string; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - ldap_dn?: string; + security_alerts_threshold: + | "none" + | "critical" + | "high_or_higher" + | "medium_or_higher" + | "all"; + /** @description The name of a code scanning tool */ + tool: string; }; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * code_scanning + * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. */ - "nullable-team-simple": { + "repository-rule-code-scanning": { + /** @enum {string} */ + type: "code_scanning"; + parameters?: { + /** @description Tools that must provide code scanning results for this rule to pass. */ + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; + }; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": + | components["schemas"]["repository-rule-creation"] + | components["schemas"]["repository-rule-update"] + | components["schemas"]["repository-rule-deletion"] + | components["schemas"]["repository-rule-required-linear-history"] + | components["schemas"]["repository-rule-merge-queue"] + | components["schemas"]["repository-rule-required-deployments"] + | components["schemas"]["repository-rule-required-signatures"] + | components["schemas"]["repository-rule-pull-request"] + | components["schemas"]["repository-rule-required-status-checks"] + | components["schemas"]["repository-rule-non-fast-forward"] + | components["schemas"]["repository-rule-commit-message-pattern"] + | 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-workflows"] + | components["schemas"]["repository-rule-code-scanning"]; + /** + * Repository ruleset + * @description A set of rules to apply when specified conditions are met. + */ + "repository-ruleset": { + /** @description The ID of the ruleset */ + id: number; + /** @description The name of the ruleset */ + name: string; /** - * @description Unique identifier of the team - * @example 1 + * @description The target of the ruleset. + * @enum {string} */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + target?: "branch" | "tag" | "push"; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The type of the source of the ruleset + * @enum {string} */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + source_type?: "Repository" | "Organization"; + /** @description The name of the source */ + source: string; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** - * @description Name of the team - * @example Justice League + * @description The bypass type of the user making the API request for this ruleset. This field is only returned when + * querying the repository-level endpoint. + * @enum {string} */ - name: string; + current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + node_id?: string; + _links?: { + self?: { + /** @description The URL of the ruleset */ + href?: string; + }; + html?: { + /** @description The html URL of the ruleset */ + href?: string; + } | null; + }; + conditions?: + | ( + | components["schemas"]["repository-ruleset-conditions"] + | components["schemas"]["org-ruleset-conditions"] + ) + | null; + rules?: components["schemas"]["repository-rule"][]; + /** Format: date-time */ + created_at?: string; + /** 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; /** - * @description Description of the team - * @example A great team. + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - description: string | null; + pushed_at?: string; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - permission: string; + result?: "pass" | "fail" | "bypass"; /** - * @description The level of privacy this team should have - * @example closed + * @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} */ - privacy?: 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 | null; + /** @description The handle for the GitHub user account. */ + actor_name?: string | null; + /** @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: uri - * @example https://github.com/orgs/rails/teams/core + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - html_url: string; + pushed_at?: string; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - repositories_url: string; - /** @example justice-league */ - slug: string; + result?: "pass" | "fail" | "bypass"; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @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`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - ldap_dn?: string; - } | null; + evaluation_result?: "pass" | "fail" | null; + /** @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 The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; + }[]; + }; /** * Team * @description Groups of organization members that gives permissions on specified repositories. @@ -14527,6 +17272,7 @@ export interface components { slug: string; description: string | null; privacy?: string; + notification_setting?: string; permission: string; permissions?: { pull: boolean; @@ -14676,6 +17422,8 @@ export interface components { web_commit_signoff_required?: boolean; /** Format: date-time */ updated_at: string; + /** Format: date-time */ + archived_at: string | null; }; /** * Full Team @@ -14715,6 +17463,12 @@ export interface components { * @enum {string} */ privacy?: "closed" | "secret"; + /** + * @description The notification setting the team has set + * @example notifications_enabled + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** * @description Permission that the team will have for its repositories * @example push @@ -15273,6 +18027,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -15388,6 +18143,7 @@ export interface components { code_scanning_upload?: components["schemas"]["rate-limit"]; actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -15715,6 +18471,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -15722,6 +18479,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -15731,6 +18489,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -15972,6 +18731,23 @@ export interface components { */ comment: string; }; + "review-custom-gates-comment-required": { + /** @description The name of the environment to approve or reject. */ + environment_name: string; + /** @description Comment associated with the pending deployment protection rule. **Required when state is not provided.** */ + comment: string; + }; + "review-custom-gates-state-required": { + /** @description The name of the environment to approve or reject. */ + environment_name: string; + /** + * @description Whether to approve or reject deployment to the specified environments. + * @enum {string} + */ + state: "approved" | "rejected"; + /** @description Optional comment to include with the review. */ + comment?: string; + }; /** * @description The type of reviewer. * @example User @@ -15985,6 +18761,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -16036,6 +18813,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -16149,6 +18927,50 @@ export interface components { */ deleted_at?: string; }; + /** + * Activity + * @description Activity + */ + activity: { + /** @example 1296269 */ + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; + /** + * @description The SHA of the commit before the activity. + * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + before: string; + /** + * @description The SHA of the commit after the activity. + * @example 827efc6d56897b048c772eb4087f854f46256132 + */ + after: string; + /** + * @description The full Git reference, formatted as `refs/heads/`. + * @example refs/heads/main + */ + ref: string; + /** + * Format: date-time + * @description The time when the activity occurred. + * @example 2011-01-26T19:06:43Z + */ + timestamp: string; + /** + * @description The type of the activity that was performed. + * @example force_push + * @enum {string} + */ + activity_type: + | "push" + | "force_push" + | "branch_deletion" + | "branch_creation" + | "pr_merge" + | "merge_queue_merge"; + actor: components["schemas"]["nullable-simple-user"]; + }; /** * Autolink reference * @description An autolink reference. @@ -16172,6 +18994,22 @@ export interface components { */ is_alphanumeric: boolean; }; + /** + * Check Automated Security Fixes + * @description Check Automated Security Fixes + */ + "check-automated-security-fixes": { + /** + * @description Whether automated security fixes are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * @description Whether automated security fixes are paused for the repository. + * @example false + */ + paused: boolean; + }; /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check @@ -16261,6 +19099,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -16278,6 +19117,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -16288,6 +19128,7 @@ export interface components { slug?: string; description?: string | null; privacy?: string; + notification_setting?: string; permission?: string; members_url?: string; repositories_url?: string; @@ -16332,8 +19173,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -16527,8 +19371,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -16746,6 +19596,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -16903,7 +19754,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -17008,7 +19862,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -17108,6 +19962,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -17130,6 +19985,11 @@ export interface components { * @example 2023-12-06T14:20:20.000Z */ updated_at?: string | null; + /** + * @description The frequency of the periodic analysis. + * @enum {string|null} + */ + schedule?: "weekly" | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup-update": { @@ -17137,13 +19997,24 @@ export interface components { * @description The desired state of code scanning default setup. * @enum {string} */ - state: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description CodeQL query suite to be used. * @enum {string} */ query_suite?: "default" | "extended"; - [key: string]: unknown; + /** @description CodeQL languages to be analyzed. */ + languages?: ( + | "actions" + | "c-cpp" + | "csharp" + | "go" + | "java-kotlin" + | "javascript-typescript" + | "python" + | "ruby" + | "swift" + )[]; }; /** * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. @@ -17161,7 +20032,7 @@ export interface components { * @example refs/heads/main */ "code-scanning-ref-full": string; - /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.9/code-security/secure-coding/sarif-support-for-code-scanning)." */ + /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.15/code-security/secure-coding/sarif-support-for-code-scanning)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { id?: components["schemas"]["code-scanning-analysis-sarif-id"]; @@ -17185,6 +20056,23 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ errors?: readonly string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -17238,7 +20126,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -17306,6 +20197,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; }; /** * Collaborator @@ -17314,7 +20207,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -17382,6 +20278,8 @@ export interface components { }; /** @example admin */ role_name?: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -17462,7 +20360,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -17697,6 +20598,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -17710,7 +20612,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -17914,6 +20815,22 @@ export interface components { }; }; }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; + }; + }; + }; /** * Contributor * @description Contributor @@ -17948,6 +20865,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -18060,6 +20978,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -18079,11 +21002,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -18094,7 +21015,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -18131,6 +21052,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -18149,6 +21075,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -18276,7 +21213,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -18308,7 +21248,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -18367,6 +21307,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -18410,6 +21351,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. */ @@ -18431,23 +21377,34 @@ 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": { @@ -18459,6 +21416,12 @@ export interface components { * @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": { @@ -18471,6 +21434,54 @@ export interface components { */ name: string; }; + /** + * Custom deployment protection rule app + * @description A GitHub App that is providing a custom deployment protection rule. + */ + "custom-deployment-rule-app": { + /** + * @description The unique identifier of the deployment protection rule integration. + * @example 3515 + */ + id: number; + /** + * @description The slugified name of the deployment protection rule integration. + * @example my-custom-app + */ + slug: string; + /** + * @description The URL for the endpoint to get details about the app. + * @example https://api.github.com/apps/custom-app-slug + */ + integration_url: string; + /** + * @description The node ID for the deployment protection rule integration. + * @example MDQ6R2F0ZTM1MTU= + */ + node_id: string; + }; + /** + * Deployment protection rule + * @description Deployment protection rule + */ + "deployment-protection-rule": { + /** + * @description The unique identifier for the deployment protection rule. + * @example 3515 + */ + id: number; + /** + * @description The node ID for the deployment protection rule. + * @example MDQ6R2F0ZTM1MTU= + */ + node_id: string; + /** + * @description Whether the deployment protection rule is enabled for the environment. + * @example true + */ + enabled: boolean; + app: components["schemas"]["custom-deployment-rule-app"]; + }; /** * Short Blob * @description Short Blob @@ -18775,6 +21786,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -18911,6 +21923,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -19328,6 +22341,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -19344,14 +22358,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -19562,11 +22582,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -19587,12 +22609,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -20069,10 +23091,12 @@ export interface components { * @description The GitHub Pages deployment status. */ "page-deployment": { + /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ + id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. - * @example https://api.github.com/repos/github/hello-world/pages/deployment/status/4fd754f7e594640989b406850d0bc8f06a121251 + * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ status_url: string; /** @@ -20088,6 +23112,25 @@ export interface components { */ preview_url?: string; }; + /** GitHub Pages deployment status */ + "pages-deployment-status": { + /** + * @description The current status of the deployment. + * @enum {string} + */ + status?: + | "deployment_in_progress" + | "syncing_files" + | "finished_file_sync" + | "updating_pages" + | "purging_cdn" + | "deployment_cancelled" + | "deployment_failed" + | "deployment_content_failed" + | "deployment_attempt_error" + | "deployment_lost" + | "succeed"; + }; "repository-pre-receive-hook": { id?: number; name?: string; @@ -20104,7 +23147,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -20213,359 +23259,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -20633,6 +23336,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -20686,9 +23390,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -20866,6 +23576,60 @@ export interface components { /** @description The generated body describing the contents of the release supporting markdown formatting */ body: string; }; + /** + * repository ruleset data for rule + * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + */ + "repository-rule-ruleset-info": { + /** + * @description The type of source for the ruleset that includes this rule. + * @enum {string} + */ + ruleset_source_type?: "Repository" | "Organization"; + /** @description The name of the source of the ruleset that includes this rule. */ + ruleset_source?: string; + /** @description The ID of the ruleset that includes this rule. */ + ruleset_id?: number; + }; + /** + * Repository Rule + * @description A repository rule with ruleset details. + */ + "repository-rule-detailed": + | (components["schemas"]["repository-rule-creation"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-update"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-deletion"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-linear-history"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-merge-queue"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-deployments"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-signatures"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-pull-request"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-required-status-checks"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-non-fast-forward"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-commit-message-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-commit-author-email-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-committer-email-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (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"]) + | (components["schemas"]["repository-rule-code-scanning"] & + components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -20891,7 +23655,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -20904,6 +23668,11 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -20937,6 +23706,42 @@ export interface components { /** @description The API URL to get the associated commit resource */ commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** @@ -20996,7 +23801,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -21005,7 +23810,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -21042,8 +23847,9 @@ export interface components { * @example commit * @enum {string} */ - type: + type?: | "commit" + | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" @@ -21055,8 +23861,9 @@ export interface components { | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; - details: + details?: | components["schemas"]["secret-scanning-location-commit"] + | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] @@ -21069,6 +23876,24 @@ export interface components { | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": + | "false_positive" + | "used_in_tests" + | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; /** * Stargazer * @description Stargazer @@ -21693,6 +24518,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -21919,6 +24750,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -21964,163 +24796,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; - }; - "configuration-status": { - status?: string; - progress?: { - status: string; - key: string; - }[]; - }; - "maintenance-status": { - status?: string; - scheduled_time?: string; - connection_services?: { - name: string; - number: number; - }[]; - }; - "enterprise-settings": { - enterprise?: { - private_mode?: boolean; - public_pages?: boolean; - subdomain_isolation?: boolean; - signup_enabled?: boolean; - github_hostname?: string; - identicons_host?: string; - http_proxy?: string | null; - auth_mode?: string; - expire_sessions?: boolean; - admin_password?: string | null; - configuration_id?: number; - configuration_run_count?: number; - avatar?: { - enabled?: boolean; - uri?: string; - }; - customer?: { - name?: string; - email?: string; - uuid?: string; - secret_key_data?: string; - public_key_data?: string; - }; - license?: { - seats?: number; - evaluation?: boolean; - perpetual?: boolean; - unlimited_seating?: boolean; - support_key?: string; - ssh_allowed?: boolean; - cluster_support?: boolean; - expire_at?: string; - }; - github_ssl?: { - enabled?: boolean; - cert?: string | null; - key?: string | null; - }; - ldap?: { - host?: string | null; - port?: number; - base?: unknown[]; - uid?: string | null; - bind_dn?: string | null; - password?: string | null; - method?: string; - search_strategy?: string; - user_groups?: unknown[]; - admin_group?: string | null; - virtual_attribute_enabled?: boolean; - recursive_group_search?: boolean; - posix_support?: boolean; - user_sync_emails?: boolean; - user_sync_keys?: boolean; - user_sync_interval?: number; - team_sync_interval?: number; - sync_enabled?: boolean; - reconciliation?: { - user?: string | null; - org?: string | null; - }; - profile?: { - uid?: string; - name?: string | null; - mail?: string | null; - key?: string | null; - }; - }; - cas?: { - url?: string | null; - }; - saml?: { - sso_url?: string | null; - certificate?: string | null; - certificate_path?: string | null; - issuer?: string | null; - idp_initiated_sso?: boolean; - disable_admin_demote?: boolean; - }; - github_oauth?: { - client_id?: string; - client_secret?: string; - organization_name?: string; - organization_team?: string; - }; - smtp?: { - enabled?: boolean; - address?: string; - authentication?: string; - port?: string; - domain?: string; - username?: string; - user_name?: string; - enable_starttls_auto?: boolean; - password?: string; - "discard-to-noreply-address"?: boolean; - support_address?: string; - support_address_type?: string; - noreply_address?: string; - }; - ntp?: { - primary_server?: string; - secondary_server?: string; - }; - timezone?: string | null; - snmp?: { - enabled?: boolean; - community?: string; - }; - syslog?: { - enabled?: boolean; - server?: string | null; - protocol_name?: string; - }; - assets?: string | null; - pages?: { - enabled?: boolean; - }; - collectd?: { - enabled?: boolean; - server?: string | null; - port?: number; - encryption?: string | null; - username?: string | null; - password?: string | null; - }; - mapping?: { - enabled?: boolean; - tileserver?: string | null; - basemap?: string; - token?: string | null; - }; - load_balancer?: string | null; - }; - run_list?: string[]; - }; - "ssh-key": { - key?: string; - "pretty-print"?: string; + user_view_type?: string; }; /** * Private User @@ -22129,8 +24805,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -22199,6 +24879,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -22240,8 +24925,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -22267,7 +24950,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -22307,6 +24993,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -22348,6 +25035,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -22408,7 +25096,7 @@ export interface components { * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.9/admin/overview/about-enterprise-accounts)." + * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.15/admin/overview/about-enterprise-accounts)." */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -22457,7 +25145,7 @@ export interface components { * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.15/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -22518,6 +25206,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -22718,6 +25407,10 @@ export interface components { */ is_template?: boolean; topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -22953,7 +25646,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -23016,7 +25709,7 @@ export interface components { }; /** * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. */ webhooks_rule: { admin_enforced: boolean; @@ -23038,6 +25731,13 @@ export interface components { | "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -23045,6 +25745,8 @@ export interface components { pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; repository_id: number; require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; required_approving_review_count: number; /** @enum {string} */ required_conversation_resolution_level: "off" | "non_admins" | "everyone"; @@ -23066,73 +25768,146 @@ export interface components { updated_at: string; }; /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. + * Push ruleset bypass exemption request data + * @description Push rules that are being requested to be bypassed. */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; + "exemption-request-push-ruleset-bypass": { /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif + * @description The type of request + * @enum {string} */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + type?: "push_ruleset_bypass"; + /** @description The data pertaining to the push rules that are being requested to be bypassed. */ + data?: { + /** @description The ID of the ruleset for the rules that were violated */ + ruleset_id?: number; + /** @description The name of the ruleset for the rules that were violated */ + ruleset_name?: string; + /** @description The number of violations */ + total_violations?: number; + /** @description The type of rule that was violated */ + rule_type?: string; + }[]; + }; + /** + * Secret scanning push protection exemption request data + * @description Secret scanning push protections that are being requested to be bypassed. + */ + "exemption-request-secret-scanning": { /** - * Format: uri - * @example https://api.github.com/users/octocat + * @description The type of request + * @enum {string} */ - url: string; + type?: "secret_scanning"; + /** @description The data pertaining to the secret scanning push protections that are being requested to be bypassed. */ + data?: { + /** @description The type of secret that was detected */ + secret_type?: string; + /** @description The location data of the secret that was detected */ + locations?: { + /** @description The commit SHA where the secret was detected */ + commit?: string; + /** @description The branch where the secret was detected */ + branch?: string; + /** @description The path of the file where the secret was detected */ + path?: string; + }[]; + }[]; + }; + /** + * Secret Scanning Push Protection Exemption Request Metadata + * @description Metadata for a secret scanning push protection exemption request. + */ + "exemption-request-secret-scanning-metadata": { + /** @description The label for the secret type */ + label?: string; /** - * Format: uri - * @example https://github.com/octocat + * @description The reason for the exemption request + * @enum {string} */ - html_url: string; + reason?: "fixed_later" | "false_positive" | "tests"; + }; + /** + * Exemption response + * @description A response to an exemption request by a delegated bypasser. + */ + "exemption-response": { + /** @description The ID of the exemption response. */ + id?: number; + /** @description The ID of the user who reviewed the exemption request. */ + reviewer_id?: number; + /** @description The login of the user who reviewed the exemption request. */ + reviewer_login?: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description The status of the exemption response. + * @enum {string} */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + status?: "approved" | "rejected" | "dismissed"; + /** @description The comment the reviewer provided when responding to the exemption request. */ + reviewer_comment?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * Format: date-time + * @description The date and time the exemption request was created. */ - subscriptions_url: string; + created_at?: string; + }; + /** + * Exemption Request + * @description A request from a user to be exempted from a set of rules. + */ + "exemption-request": { + /** @description The ID of the exemption request. */ + id?: number; + /** @description The number uniquely identifying the exemption request within it's repository. */ + number?: number; + /** @description The ID of the repository the exemption request is for. */ + repository_id?: number; + /** @description The ID of the user who requested the exemption. */ + requester_id?: number; + /** @description The login of the user who requested the exemption. */ + requester_login?: string; + /** + * @description The type of request. + * @enum {string} + */ + request_type?: "push_ruleset_bypass" | "secret_scanning"; + exemption_request_data?: + | components["schemas"]["exemption-request-push-ruleset-bypass"] + | components["schemas"]["exemption-request-secret-scanning"]; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The unique identifier for the request type of the exemption request. For example, a commit SHA. + * @example 827efc6d56897b048c772eb4087f854f46256132 */ - organizations_url: string; + resource_identifier?: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * @description The status of the exemption request. + * @enum {string} */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + status?: "pending" | "rejected" | "cancelled" | "completed"; + /** @description The comment the requester provided when creating the exemption request. */ + requester_comment?: string | null; + /** @description Metadata about the exemption request. */ + metadata?: + | components["schemas"]["exemption-request-secret-scanning-metadata"] + | null; + /** + * Format: date-time + * @description The date and time the exemption request will expire. + */ + expires_at?: string; + /** + * Format: date-time + * @description The date and time the exemption request was created. + */ + created_at?: string; + /** @description The responses to the exemption request. */ + responses?: components["schemas"]["exemption-response"][] | null; /** * Format: uri - * @example https://api.github.com/users/octocat/received_events + * @description The URL to view the exemption request in a browser. + * @example https://github.com/monalisa/smile/exemptions/1 */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; + html_url?: string; }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { @@ -23263,9 +26038,9 @@ export interface components { webhooks_code_scanning_ref: string; /** @description The pusher type for the event. Can be either `user` or a deploy key. */ webhooks_deploy_pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/enterprise-server@3.9/rest/git/refs#get-a-reference) resource. */ + /** @description The [`git ref`](https://docs.github.com/enterprise-server@3.15/rest/git/refs#get-a-reference) resource. */ webhooks_ref_0: string; - /** @description The [`deploy key`](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ + /** @description The [`deploy key`](https://docs.github.com/enterprise-server@3.15/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ webhooks_deploy_key: { added_by?: string | null; created_at: string; @@ -23315,6 +26090,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -23384,6 +26160,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -23403,6 +26180,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -23462,6 +26240,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -23481,6 +26260,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -23526,6 +26306,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -23613,6 +26394,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -23632,7 +26414,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -23690,6 +26474,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -23709,6 +26494,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -23756,7 +26542,7 @@ export interface components { webhooks_repository_selection: "all" | "selected"; /** * issue comment - * @description The [comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment) itself. */ webhooks_issue_comment: { /** @@ -23826,6 +26612,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -23845,6 +26632,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -23856,7 +26644,7 @@ export interface components { }; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ webhooks_issue: { /** @enum {string|null} */ @@ -23902,6 +26690,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -23938,6 +26727,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -24033,6 +26823,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -24163,6 +26954,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -24270,6 +27062,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -24304,6 +27102,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24323,6 +27122,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -24371,6 +27171,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -24398,7 +27199,7 @@ export interface components { }; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ webhooks_issue_2: { /** @enum {string|null} */ @@ -24444,6 +27245,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -24480,6 +27282,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -24575,6 +27378,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -24703,6 +27507,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -24810,6 +27615,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -24844,6 +27655,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -24863,6 +27675,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -24901,6 +27714,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Team @@ -24935,6 +27749,13 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting: + | "notifications_enabled" + | "notifications_disabled"; /** Format: uri */ repositories_url: string; slug: string; @@ -24948,6 +27769,8 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; + /** @enum {string} */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ repositories_url?: string; slug?: string; @@ -24964,6 +27787,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -25164,6 +27988,10 @@ export interface components { */ is_template?: boolean; topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -25399,7 +28227,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -25506,6 +28334,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -25559,6 +28388,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25578,8 +28408,86 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; + /** + * Personal Access Token Request + * @description Details of a Personal Access Token Request. + */ + "personal-access-token-request": { + /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ + id: number; + owner: components["schemas"]["simple-user"]; + /** @description New requested permissions, categorized by type of permission. */ + permissions_added: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ + permissions_upgraded: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ + permissions_result: { + organization?: { + [key: string]: string; + }; + repository?: { + [key: string]: string; + }; + other?: { + [key: string]: string; + }; + }; + /** + * @description Type of repository selection requested. + * @enum {string} + */ + repository_selection: "none" | "all" | "subset"; + /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + repository_count: number | null; + /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + repositories: + | { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[] + | null; + /** @description Date and time when the request for access was created. */ + created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; + /** @description Whether the associated fine-grained personal access token has expired. */ + token_expired: boolean; + /** @description Date and time when the associated fine-grained personal access token expires. */ + token_expires_at: string | null; + /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + token_last_used_at: string | null; + }; /** Project Card */ webhooks_project_card: { after_id?: number | null; @@ -25628,6 +28536,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -25684,6 +28593,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -25800,6 +28710,26 @@ export interface components { */ archived_at: string | null; }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-option": { + id: string; + name: string; + color?: string | null; + description?: string | null; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-setting": { + id: string; + title: string; + duration?: number | null; + start_date?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -25846,7 +28776,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -25939,6 +28869,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -26035,6 +28966,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -26162,7 +29094,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -26255,6 +29190,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -26344,6 +29280,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26363,6 +29300,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -26502,7 +29440,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -26595,6 +29536,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -26684,6 +29626,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26703,6 +29646,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -26770,6 +29714,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -26817,6 +29762,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -27025,6 +29971,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27044,11 +29991,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ webhooks_review_comment: { _links: { @@ -27178,6 +30126,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27197,6 +30146,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -27258,6 +30208,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27277,12 +30228,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases/#get-a-release) object. */ webhooks_release: { assets: { @@ -27383,6 +30335,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -27429,7 +30382,7 @@ export interface components { }; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases/#get-a-release) object. */ webhooks_release_1: { assets: ({ @@ -27530,6 +30483,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -27670,6 +30624,11 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} @@ -27690,6 +30649,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -27742,6 +30702,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -27781,6 +30742,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -27818,6 +30780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -27889,6 +30852,13 @@ export interface components { permission: string; /** @enum {string} */ privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting: + | "notifications_enabled" + | "notifications_disabled"; /** Format: uri */ repositories_url: string; slug: string; @@ -27902,6 +30872,11 @@ export interface components { permission?: string; /** @enum {string} */ privacy?: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ repositories_url?: string; slug?: string; @@ -27911,6 +30886,26 @@ export interface components { */ url?: string; }; + /** branch protection configuration disabled event */ + "webhook-branch-protection-configuration-disabled": { + /** @enum {string} */ + action: "disabled"; + 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"]; + }; + /** branch protection configuration enabled event */ + "webhook-branch-protection-configuration-enabled": { + /** @enum {string} */ + action: "enabled"; + 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"]; + }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { /** @enum {string} */ @@ -27920,7 +30915,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -27931,7 +30926,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -27955,6 +30950,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync?: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -27968,7 +30977,64 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request cancellation event */ + "webhook-exemption-request-cancelled": { + /** @enum {string} */ + action: "cancelled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request completed event */ + "webhook-exemption-request-completed": { + /** @enum {string} */ + action: "completed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption request created event */ + "webhook-exemption-request-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"]; + exemption_request: components["schemas"]["exemption-request"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption response dismissed event */ + "webhook-exemption-request-response-dismissed": { + /** @enum {string} */ + action: "response_dismissed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + exemption_response: components["schemas"]["exemption-response"]; + sender: components["schemas"]["simple-user"]; + }; + /** Exemption response submitted event */ + "webhook-exemption-request-response-submitted": { + /** @enum {string} */ + action: "response_submitted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + exemption_request: components["schemas"]["exemption-request"]; + exemption_response: components["schemas"]["exemption-response"]; + sender: components["schemas"]["simple-user"]; }; "webhook-cache-sync": { after: string; @@ -27979,7 +31045,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -27989,7 +31055,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -28007,7 +31073,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -28030,7 +31096,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -28048,7 +31114,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -28062,7 +31128,7 @@ export interface components { "webhook-check-suite-completed": { /** @enum {string} */ action: "completed"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -28134,6 +31200,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -28173,6 +31241,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -28366,13 +31435,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { /** @enum {string} */ action: "requested"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -28445,6 +31514,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -28484,6 +31555,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -28670,13 +31742,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { /** @enum {string} */ action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite). */ + /** @description The [check_suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#get-a-check-suite). */ check_suite: { after: string | null; /** @@ -28744,6 +31816,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -28783,6 +31857,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -28968,7 +32043,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -29022,6 +32097,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -29098,7 +32174,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -29152,6 +32228,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -29235,7 +32312,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -29310,9 +32387,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -29330,7 +32407,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -29384,6 +32461,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -29469,7 +32547,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -29562,7 +32640,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -29646,7 +32724,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -29655,7 +32733,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -29722,6 +32800,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29741,13 +32820,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; 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"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -29766,7 +32846,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** delete event */ "webhook-delete": { @@ -29781,7 +32861,29 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert auto-dismissed event */ + "webhook-dependabot-alert-auto-dismissed": { + /** @enum {string} */ + action: "auto_dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert auto-reopened event */ + "webhook-dependabot-alert-auto-reopened": { + /** @enum {string} */ + action: "auto_reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -29792,7 +32894,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -29803,7 +32905,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -29814,7 +32916,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -29825,7 +32927,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -29836,7 +32938,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -29847,7 +32949,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -29858,7 +32960,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -29866,7 +32968,7 @@ export interface components { action: "created"; /** * Deployment - * @description The [deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -29906,6 +33008,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -30019,6 +33122,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -30115,7 +33219,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -30155,6 +33259,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -30405,6 +33510,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -30414,6 +33520,26 @@ export interface components { workflow_url?: string; } | null; }; + /** deployment protection rule requested event */ + "webhook-deployment-protection-rule-requested": { + /** @enum {string} */ + action?: "requested"; + /** @description The name of the environment that has the deployment protection rule. */ + environment?: string; + /** @description The event that triggered the deployment protection rule. */ + event?: string; + /** + * Format: uri + * @description The URL to review the deployment protection rule. + */ + deployment_callback_url?: string; + deployment?: components["schemas"]["deployment"]; + pull_requests?: components["schemas"]["pull-request"][]; + repository?: components["schemas"]["repository-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + sender?: components["schemas"]["simple-user"]; + }; "webhook-deployment-review-approved": { /** @enum {string} */ action: "approved"; @@ -30424,7 +33550,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -30475,6 +33601,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -30551,6 +33678,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -30663,6 +33791,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -30725,6 +33854,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -30744,7 +33874,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -30795,6 +33925,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -30870,6 +34001,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -30982,6 +34114,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31043,6 +34176,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -31099,11 +34233,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -31153,6 +34288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -31228,6 +34364,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31340,6 +34477,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -31402,6 +34540,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -31457,7 +34596,7 @@ export interface components { } | null; /** * Deployment - * @description The [deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments). + * @description The [deployment](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments#list-deployments). */ deployment: { created_at: string; @@ -31497,6 +34636,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -31610,6 +34750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31702,7 +34843,7 @@ export interface components { /** Format: uri */ url: string; }; - /** @description The [deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#list-deployment-statuses). */ + /** @description The [deployment status](https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#list-deployment-statuses). */ deployment_status: { created_at: string; /** User */ @@ -31741,6 +34882,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -31859,6 +35001,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31952,7 +35095,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -31992,6 +35135,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -32243,6 +35387,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -32262,7 +35407,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -32290,7 +35435,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -32301,7 +35446,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -32313,7 +35458,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -32325,7 +35470,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -32342,7 +35487,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -32353,7 +35498,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -32364,7 +35509,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -32383,7 +35528,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -32395,7 +35540,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -32406,7 +35551,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -32417,7 +35562,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -32428,7 +35573,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -32443,7 +35588,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -32453,7 +35598,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -32465,7 +35610,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -32476,7 +35621,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -32487,17 +35632,17 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-disabled": { /** @enum {string} */ action: "anonymous_access_disabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-enterprise-anonymous-access-enabled": { /** @enum {string} */ action: "anonymous_access_enabled"; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** * fork event @@ -32505,7 +35650,7 @@ export interface components { */ "webhook-fork": { enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The created [`repository`](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) resource. */ + /** @description The created [`repository`](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository) resource. */ forkee: { /** * @description Whether to allow auto-merge for pull requests. @@ -32558,10 +35703,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -32618,7 +35759,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -32694,6 +35838,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -32845,13 +35990,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -32879,7 +36024,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -32891,7 +36036,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -32903,7 +36048,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -32915,7 +36060,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -32939,7 +36084,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -32963,7 +36108,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -32975,10 +36120,11 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { + archived_at?: string | null; avatar_url: string; created_at?: string; description?: unknown; @@ -33014,6 +36160,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -33029,7 +36176,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -33042,7 +36189,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -33050,7 +36197,7 @@ export interface components { action: "created"; /** * issue comment - * @description The [comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment) itself. */ comment: { /** @@ -33120,6 +36267,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33139,11 +36287,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -33188,6 +36337,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -33224,6 +36374,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -33319,6 +36470,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -33449,6 +36601,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -33556,6 +36709,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -33590,6 +36749,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -33609,6 +36769,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -33648,6 +36809,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -33710,6 +36872,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -33725,7 +36888,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -33734,7 +36897,7 @@ export interface components { comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -33779,6 +36942,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -33815,6 +36979,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -33910,6 +37075,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34038,6 +37204,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34145,6 +37312,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -34179,6 +37352,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34198,6 +37372,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -34237,6 +37412,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -34299,6 +37475,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -34310,11 +37487,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -34324,7 +37502,7 @@ export interface components { comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -34369,6 +37547,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -34405,6 +37584,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -34500,6 +37680,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -34630,6 +37811,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34737,6 +37919,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -34771,6 +37959,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -34790,6 +37979,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -34829,6 +38019,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -34891,6 +38082,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -34906,7 +38098,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -34921,7 +38113,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -34932,7 +38124,7 @@ export interface components { action: "closed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. */ + /** @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: @@ -34977,6 +38169,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35013,6 +38206,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -35108,6 +38302,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35239,6 +38434,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35346,6 +38542,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35380,6 +38582,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35399,6 +38602,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -35447,6 +38651,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -35458,11 +38663,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -35472,7 +38678,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -35518,6 +38724,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -35649,6 +38856,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -35778,6 +38986,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -35885,6 +39094,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35919,6 +39134,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35938,11 +39154,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -35952,7 +39169,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36129,6 +39346,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36257,6 +39475,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36364,6 +39583,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36398,6 +39623,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36417,12 +39643,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -36443,7 +39670,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36489,6 +39716,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36620,6 +39848,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36751,6 +39980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36858,6 +40088,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36892,6 +40128,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36911,12 +40148,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -36926,7 +40164,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -36972,6 +40210,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37103,6 +40342,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37233,6 +40473,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37340,6 +40581,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37374,6 +40621,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37393,12 +40641,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -37408,7 +40657,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -37454,6 +40703,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37490,6 +40740,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37586,6 +40837,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37716,6 +40968,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37823,6 +41076,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37857,6 +41116,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37876,11 +41136,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -37890,7 +41151,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -38067,6 +41328,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38196,6 +41458,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38303,6 +41566,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38337,6 +41606,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38356,12 +41626,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -38370,7 +41641,7 @@ export interface components { changes?: { /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ old_issue: { /** @enum {string|null} */ @@ -38416,6 +41687,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38452,6 +41724,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -38547,6 +41820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38675,6 +41949,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38782,6 +42057,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38816,6 +42097,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38835,6 +42117,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -38893,6 +42176,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -38951,7 +42238,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -39027,6 +42317,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -39081,7 +42372,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -39127,6 +42418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39163,6 +42455,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -39258,6 +42551,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39389,6 +42683,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39496,6 +42791,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39530,6 +42831,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39549,11 +42851,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -39564,7 +42867,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -39574,7 +42877,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -39751,6 +43054,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39881,6 +43185,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39988,6 +43293,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40022,6 +43333,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40041,11 +43353,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -40054,7 +43367,7 @@ export interface components { changes: { /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ new_issue: { /** @enum {string|null} */ @@ -40100,6 +43413,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40136,6 +43450,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40231,6 +43546,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40359,6 +43675,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40466,6 +43783,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40500,6 +43823,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40519,6 +43843,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -40577,6 +43902,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -40638,7 +43967,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -40714,6 +44046,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -40769,7 +44102,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -40784,7 +44117,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -40796,7 +44129,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -40806,7 +44139,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; /** * Issue - * @description The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. + * @description The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ @@ -40852,6 +44185,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40888,6 +44222,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40984,6 +44319,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41112,6 +44448,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41219,6 +44556,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41253,6 +44596,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41272,11 +44616,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -41287,7 +44632,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -41298,7 +44643,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -41309,7 +44654,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -41335,7 +44680,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -41362,7 +44707,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -41384,7 +44729,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -41395,7 +44740,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -41447,6 +44792,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -41500,6 +44846,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -41584,7 +44931,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -41595,7 +44942,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -41606,7 +44953,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -41617,7 +44964,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -41643,7 +44990,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -41654,7 +45001,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -41665,7 +45012,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -41676,7 +45023,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -41731,6 +45078,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -41740,7 +45088,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -41752,7 +45100,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -41768,7 +45116,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -41842,6 +45190,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -41881,6 +45230,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -42018,6 +45368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -42053,7 +45404,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -42108,6 +45459,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -42147,6 +45499,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -42218,6 +45571,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -42254,11 +45608,11 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.9/rest/pages/pages#list-github-pages-builds) itself. */ + /** @description The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.15/rest/pages/pages#list-github-pages-builds) itself. */ build: { commit: string | null; created_at: string; @@ -42302,6 +45656,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -42313,7 +45668,47 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** personal_access_token_request approved event */ + "webhook-personal-access-token-request-approved": { + /** @enum {string} */ + action: "approved"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request cancelled event */ + "webhook-personal-access-token-request-cancelled": { + /** @enum {string} */ + action: "cancelled"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request created event */ + "webhook-personal-access-token-request-created": { + /** @enum {string} */ + action: "created"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request denied event */ + "webhook-personal-access-token-request-denied": { + /** @enum {string} */ + action: "denied"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; + installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { /** @@ -42359,7 +45754,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -42382,7 +45777,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -42393,7 +45788,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -42450,6 +45845,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -42463,7 +45859,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -42479,7 +45875,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -42540,6 +45936,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -42585,7 +45982,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -42596,7 +45993,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -42607,7 +46004,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -42618,7 +46015,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -42634,7 +46031,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -42645,7 +46042,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -42656,7 +46053,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -42667,7 +46064,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -42689,7 +46086,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -42700,7 +46097,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -42709,7 +46106,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -42718,7 +46115,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -42727,7 +46124,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -42754,7 +46151,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -42764,7 +46161,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -42779,7 +46176,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -42788,7 +46185,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -42797,18 +46194,36 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { field_value: { field_node_id?: string; field_type?: string; + field_name?: string; + project_number?: number; + from?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; + to?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; }; }, { @@ -42822,7 +46237,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -42837,7 +46252,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -42847,7 +46262,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -42856,7 +46271,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -42864,7 +46279,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -42963,6 +46378,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42999,6 +46415,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43059,6 +46476,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -43186,7 +46604,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -43279,6 +46700,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43342,7 +46764,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -43371,6 +46793,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43390,6 +46813,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -43529,7 +46953,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -43622,6 +47049,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43685,7 +47113,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -43714,6 +47142,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43733,6 +47162,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -43800,6 +47230,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -43847,6 +47278,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43915,6 +47347,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -44055,6 +47488,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44074,10 +47508,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -44175,6 +47610,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -44271,6 +47707,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -44398,7 +47835,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -44491,6 +47931,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -44554,7 +47995,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -44583,6 +48024,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44602,6 +48044,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -44741,7 +48184,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -44834,6 +48280,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -44897,7 +48344,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -44926,6 +48373,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44945,6 +48393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -45012,6 +48461,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -45059,6 +48509,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -45127,6 +48578,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -45267,6 +48719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45286,11 +48739,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -45388,6 +48842,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -45484,6 +48939,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -45611,7 +49067,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -45704,6 +49163,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -45767,7 +49227,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -45796,6 +49256,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -45815,6 +49276,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -46047,6 +49509,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46110,7 +49573,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46139,6 +49602,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46158,6 +49622,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -46225,6 +49690,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -46272,6 +49738,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46340,6 +49807,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -46480,6 +49948,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46499,11 +49968,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -46515,7 +49985,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -46527,7 +49997,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -46539,7 +50009,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -46570,7 +50040,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -46669,6 +50139,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46765,6 +50236,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -46892,7 +50364,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46985,6 +50460,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47048,7 +50524,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47077,6 +50553,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47096,6 +50573,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -47235,7 +50713,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47328,6 +50809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47391,7 +50873,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47420,6 +50902,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47439,6 +50922,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -47506,6 +50990,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -47553,6 +51038,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -47621,6 +51107,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -47761,6 +51248,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47780,10 +51268,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -47881,6 +51370,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47977,6 +51467,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48104,7 +51595,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48197,6 +51691,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48260,7 +51755,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48289,6 +51784,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48308,6 +51804,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -48447,7 +51944,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48540,6 +52040,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48603,7 +52104,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48632,6 +52133,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48651,6 +52153,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -48718,6 +52221,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -48765,6 +52269,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48833,6 +52338,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -48973,6 +52479,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48992,10 +52499,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -49007,7 +52515,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -49019,7 +52527,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -49031,7 +52539,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -49043,7 +52551,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -49051,7 +52559,7 @@ export interface components { action: "created"; /** * Pull Request Review Comment - * @description The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + * @description The [comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ comment: { _links: { @@ -49181,6 +52689,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49200,6 +52709,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -49291,6 +52801,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49387,6 +52898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -49514,7 +53026,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49607,6 +53122,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49670,7 +53186,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49699,6 +53215,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49718,6 +53235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -49850,7 +53368,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49943,6 +53464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50006,7 +53528,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50035,6 +53557,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50054,6 +53577,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50125,6 +53649,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50191,6 +53716,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50325,6 +53851,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50344,10 +53871,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -50443,6 +53971,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50539,6 +54068,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -50666,7 +54196,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50759,6 +54292,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50822,7 +54356,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50851,6 +54385,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50870,6 +54405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51002,7 +54538,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51095,6 +54634,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51158,7 +54698,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51187,6 +54727,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51206,6 +54747,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -51277,6 +54819,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51343,6 +54886,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -51477,6 +55021,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51496,10 +55041,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -51596,6 +55142,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -51632,6 +55179,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -51692,6 +55240,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -51819,7 +55368,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51912,6 +55464,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51975,7 +55528,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52004,6 +55557,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52023,6 +55577,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52155,7 +55710,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52248,6 +55806,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52311,7 +55870,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52340,6 +55899,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52359,6 +55919,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -52430,6 +55991,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -52496,6 +56058,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -52630,6 +56193,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52647,12 +56211,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -52748,6 +56313,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52844,6 +56410,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52971,7 +56538,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53064,6 +56634,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53127,7 +56698,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53156,6 +56727,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53175,6 +56747,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53307,7 +56880,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53400,6 +56976,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53463,7 +57040,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53492,6 +57069,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53511,6 +57089,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -53582,6 +57161,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53648,6 +57228,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53782,6 +57363,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53801,6 +57383,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -53864,6 +57447,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53883,9 +57467,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -53987,6 +57572,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54083,6 +57669,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54205,294 +57792,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** 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; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - }; - sha: string; - /** 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; - }; - body: string | null; - closed_at: string | null; - /** Format: uri */ - comments_url: string; - /** Format: uri */ - commits_url: string; - created_at: string; - /** Format: uri */ - diff_url: string; - draft: boolean; - head: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; /** - * @description Whether to allow squash merges for pull requests. - * @default true + * Format: int64 + * @description Unique identifier of the repository */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -54568,6 +57871,300 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + }; + sha: string; + /** 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; + /** Format: int64 */ + 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; + user_view_type?: string; + } | null; + }; + body: string | null; + closed_at: string | null; + /** Format: uri */ + comments_url: string; + /** Format: uri */ + commits_url: string; + created_at: string; + /** Format: uri */ + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** 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; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54633,6 +58230,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54652,6 +58250,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54723,6 +58322,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54789,6 +58389,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -54923,6 +58524,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54942,11 +58544,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -55047,6 +58650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55083,6 +58687,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -55143,6 +58748,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -55270,7 +58876,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55363,6 +58972,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55419,7 +59029,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55448,6 +59058,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55467,6 +59078,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55606,7 +59218,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55699,6 +59314,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55762,7 +59378,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55791,6 +59407,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55810,6 +59427,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55877,6 +59495,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -55924,6 +59543,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55992,6 +59612,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56132,6 +59753,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56151,6 +59773,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -56190,8 +59813,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -56289,6 +59913,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -56325,6 +59950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -56385,6 +60011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56512,7 +60139,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56605,6 +60235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56668,7 +60299,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56697,6 +60328,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56716,6 +60348,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56855,7 +60488,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56948,6 +60584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57011,7 +60648,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57040,6 +60677,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57059,6 +60697,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57126,6 +60765,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -57173,6 +60813,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57241,6 +60882,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -57381,6 +61023,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57400,6 +61043,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -57458,7 +61102,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -57561,6 +61205,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57597,6 +61242,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -57657,6 +61303,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57784,7 +61431,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57877,6 +61527,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57940,7 +61591,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57969,6 +61620,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57988,6 +61640,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58127,7 +61780,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58220,6 +61876,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58283,7 +61940,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58312,6 +61969,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58331,6 +61989,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -58398,6 +62057,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -58445,6 +62105,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -58513,6 +62174,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -58653,6 +62315,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58672,6 +62335,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -58711,8 +62375,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -58810,6 +62475,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58846,6 +62512,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -58906,6 +62573,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59033,7 +62701,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59126,6 +62797,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59189,7 +62861,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -59218,6 +62890,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59237,6 +62910,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59376,7 +63050,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59469,6 +63146,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59532,7 +63210,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -59561,6 +63239,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59580,6 +63259,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59647,6 +63327,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -59694,6 +63375,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59762,6 +63444,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -59902,6 +63585,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59921,6 +63605,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -59979,7 +63664,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -60077,6 +63762,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60173,6 +63859,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60300,7 +63987,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60393,6 +64083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60456,7 +64147,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60485,6 +64176,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60504,6 +64196,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -60636,7 +64329,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60729,6 +64425,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60792,7 +64489,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60821,6 +64518,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60840,6 +64538,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60911,6 +64610,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60977,6 +64677,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61111,6 +64812,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61130,11 +64832,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -61230,6 +64933,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61326,6 +65030,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61453,7 +65158,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61529,6 +65237,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61596,6 +65305,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61615,6 +65325,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61747,7 +65458,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61823,6 +65537,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61890,6 +65605,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61909,6 +65625,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61980,6 +65697,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62046,6 +65764,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -62180,6 +65899,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62199,10 +65919,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -62332,6 +66053,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62351,6 +66073,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -62450,6 +66173,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -62546,6 +66270,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -62673,7 +66398,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62749,6 +66477,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62816,6 +66545,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62835,6 +66565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62967,7 +66698,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63043,6 +66777,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63110,6 +66845,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63129,6 +66865,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63200,6 +66937,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63266,6 +67004,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -63400,6 +67139,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63419,10 +67159,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -63552,6 +67293,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63571,6 +67313,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -63674,6 +67417,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63770,6 +67514,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63897,7 +67642,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63990,6 +67738,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64053,7 +67802,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64082,6 +67831,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64101,6 +67851,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64240,7 +67991,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64326,6 +68080,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64389,7 +68144,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64418,6 +68173,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64437,6 +68193,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -64504,6 +68261,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -64551,6 +68309,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -64619,6 +68378,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -64759,6 +68519,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64778,10 +68539,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -64880,6 +68642,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64976,6 +68739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65103,7 +68867,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65196,6 +68963,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65259,7 +69027,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65288,6 +69056,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65307,6 +69076,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -65446,7 +69216,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65539,6 +69312,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65602,7 +69376,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65631,6 +69405,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65650,6 +69425,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65717,6 +69493,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -65764,6 +69541,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65832,6 +69610,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -65972,6 +69751,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65991,10 +69771,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -66093,6 +69874,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66189,6 +69971,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66316,7 +70099,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66409,6 +70195,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66472,7 +70259,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66501,6 +70288,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66520,6 +70308,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66659,7 +70448,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66745,6 +70537,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66808,7 +70601,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66837,6 +70630,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66856,6 +70650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66923,6 +70718,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -66970,6 +70766,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67038,6 +70835,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67178,6 +70976,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67197,10 +70996,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -67298,6 +71098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67394,6 +71195,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -67521,7 +71323,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67614,6 +71419,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67677,7 +71483,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -67706,6 +71512,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67725,6 +71532,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67864,7 +71672,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67957,6 +71768,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68020,7 +71832,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -68049,6 +71861,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68068,6 +71881,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68135,6 +71949,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -68182,6 +71997,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68250,6 +72066,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -68390,6 +72207,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68409,10 +72227,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -68421,7 +72240,7 @@ export interface components { base_ref: components["schemas"]["webhooks_nullable_string"]; /** @description The SHA of the most recent commit on `ref` before the push. */ before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.9/rest/commits) to fetch additional commits. */ + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.15/rest/commits) to fetch additional commits. */ commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ added?: string[]; @@ -68605,6 +72424,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -68666,7 +72489,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68742,6 +72568,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68791,7 +72618,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -68826,6 +72653,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -68848,6 +72676,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -68966,6 +72795,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -68996,7 +72826,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -69031,6 +72861,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -69053,6 +72884,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -69105,6 +72937,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -69129,7 +72962,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -69140,7 +72973,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -69151,7 +72984,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -69176,7 +73009,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -69187,7 +73020,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; /** * Release - * @description The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. + * @description The [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases/#get-a-release) object. */ release: { assets: ({ @@ -69288,6 +73121,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -69336,7 +73170,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -69347,7 +73181,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -69358,7 +73192,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -69369,7 +73203,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-disabled": { /** @enum {string} */ @@ -69378,7 +73212,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-repository-anonymous-access-enabled": { /** @enum {string} */ @@ -69387,7 +73221,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -69397,7 +73231,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -69407,7 +73241,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -69417,7 +73251,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -69432,7 +73266,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -69456,7 +73290,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository privatized event */ "webhook-repository-privatized": { @@ -69466,7 +73300,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -69476,7 +73310,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -69493,7 +73327,87 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset created event */ + "webhook-repository-ruleset-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"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset deleted event */ + "webhook-repository-ruleset-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"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; + }; + /** repository ruleset edited event */ + "webhook-repository-ruleset-edited": { + /** @enum {string} */ + action: "edited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; + }; + target?: { + from?: string; + }; + include?: { + from?: string[]; + }; + exclude?: { + from?: string[]; + }; + }; + }[]; + }; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; + }; + rule_type?: { + from?: string; + }; + pattern?: { + from?: string; + }; + }; + }[]; + }; + }; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -69544,6 +73458,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69563,6 +73478,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -69571,7 +73487,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -69581,7 +73497,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -69592,7 +73508,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -69645,6 +73561,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -69665,7 +73582,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -69676,7 +73593,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -69748,7 +73665,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -69759,7 +73676,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -69770,7 +73687,7 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { @@ -69786,7 +73703,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -69797,18 +73714,18 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - action: "revoked"; + action: "validated"; alert: components["schemas"]["secret-scanning-alert-webhook"]; 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"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -69819,7 +73736,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -69830,7 +73747,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -69846,6 +73763,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -69877,7 +73795,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -69890,7 +73808,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -69900,7 +73818,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -69911,7 +73829,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -69928,7 +73846,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -69940,7 +73858,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -69953,7 +73871,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -69965,7 +73883,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -69976,7 +73894,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -69988,7 +73906,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -70167,7 +74085,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -70185,7 +74103,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -70251,6 +74169,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -70307,7 +74229,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70383,6 +74308,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70430,7 +74356,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ @@ -70496,6 +74422,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -70552,7 +74482,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70628,6 +74561,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70675,7 +74609,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -70741,6 +74675,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -70797,7 +74735,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70873,6 +74814,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70920,7 +74862,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -71017,6 +74959,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -71073,7 +75019,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71149,6 +75098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71196,7 +75146,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -71262,6 +75212,10 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -71318,7 +75272,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71394,6 +75351,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71441,7 +75399,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; "webhook-user-created": { @@ -71451,7 +75409,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; "webhook-user-deleted": { @@ -71461,7 +75419,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** watch started event */ @@ -71472,7 +75430,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -71484,7 +75442,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -71495,7 +75453,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -71516,7 +75474,7 @@ export interface components { /** Format: uri */ html_url: string; id: number; - /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.9/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ + /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.15/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ labels: string[]; name: string; node_id: string; @@ -71600,7 +75558,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -71613,7 +75571,7 @@ export interface components { /** Format: uri */ html_url: string; id: number; - /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.9/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ + /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.15/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ labels: string[]; name: string; node_id: string; @@ -71698,7 +75656,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -71752,7 +75710,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -71811,7 +75769,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -71851,6 +75809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -71870,6 +75829,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -72010,6 +75970,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -72184,6 +76145,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -72258,6 +76220,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -72281,7 +76244,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -72745,7 +76708,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -72785,6 +76748,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -72945,6 +76909,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -73119,6 +77084,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -73193,6 +77159,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -73206,18 +77173,18 @@ export interface components { }; }; responses: { - /** @description Resource not found */ - not_found: { - content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; + /** @description Resource not found */ + not_found: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Bad Request */ bad_request: { content: { @@ -73260,6 +77227,16 @@ export interface components { }; }; /** @description Response */ + actions_runner_jitconfig: { + content: { + "application/json": { + runner: components["schemas"]["runner"]; + /** @description The base64 encoded runner configuration. */ + encoded_jit_config: string; + }; + }; + }; + /** @description Response */ actions_runner_labels: { content: { "application/json": { @@ -73287,12 +77264,6 @@ export interface components { }; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ - code_scanning_forbidden_read: { - content: { - "application/json": components["schemas"]["basic-error"]; - }; - }; /** @description Forbidden Gist */ forbidden_gist: { content: { @@ -73319,18 +77290,28 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description A header with no content is returned. */ + no_content: { + content: never; + }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { content: never; }; + /** @description Internal Error */ + internal_error: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Temporary Redirect */ temporary_redirect: { content: { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Response if GitHub Advanced Security is not enabled for this repository */ + code_scanning_forbidden_read: { content: { "application/json": components["schemas"]["basic-error"]; }; @@ -73363,10 +77344,6 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description A header with no content is returned. */ - no_content: { - content: never; - }; /** @description Bad request */ scim_bad_request: { content: { @@ -73402,9 +77379,9 @@ export interface components { }; }; parameters: { - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "per-page"?: number; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @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; @@ -73424,6 +77401,12 @@ export interface components { "pre-receive-hook-id": number; /** @description The unique identifier of the token. */ "token-id": number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "pagination-before"?: string; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "pagination-after"?: string; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ + ghsa_id: string; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: string; "delivery-id": number; @@ -73452,7 +77435,7 @@ export interface components { "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; - /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ "audit-log-enterprise-phrase"?: string; /** * @description The event types to include: @@ -73464,9 +77447,9 @@ export interface components { * The default is `web`. */ "audit-log-include"?: "web" | "git" | "all"; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ "audit-log-after"?: string; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ "audit-log-before"?: string; /** * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -73478,10 +77461,6 @@ 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 A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * @@ -73524,22 +77503,22 @@ export interface components { "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution"?: string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ "secret-scanning-alert-sort"?: "created" | "updated"; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ + "secret-scanning-alert-validity"?: string; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" + | "advanced_security_user_namespace" | "dependabot_alerts" | "secret_scanning" - | "secret_scanning_push_protection"; + | "secret_scanning_push_protection" + | "secret_scanning_non_provider_patterns"; /** * @description The action to take. * @@ -73553,6 +77532,8 @@ export interface components { "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: string; + /** @description Whether to instantly apply changes from the license. Otherwise the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) endpoint. */ + "license-apply"?: boolean; /** @description The UUID which identifies a node. */ uuid?: string; /** @description The cluster roles from the cluster configuration file. */ @@ -73567,7 +77548,7 @@ export interface components { participating?: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: string; - /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ "since-org"?: number; @@ -73577,25 +77558,33 @@ export interface components { "visible-to-repository"?: string; /** @description The name of the secret. */ "secret-name": string; - /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ "variables-per-page"?: number; /** @description The name of the variable. */ "variable-name": string; - /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ "audit-log-phrase"?: string; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description The unique identifier of the role. */ "role-id": number; /** @description The unique identifier of the group. */ "group-id": number; + /** @description The number of results per page for the "members" array (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-per-page"?: number; + /** @description The page number of the "members" array results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + "members-page"?: number; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ "repo-name": string; + /** @description The slug of the team name. */ + "team-slug": string; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ "package-visibility"?: "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ @@ -73610,12 +77599,53 @@ export interface components { "package-name": string; /** @description Unique identifier of the package version. */ "package-version-id": number; - /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/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. */ + /** @description The property by which to sort the results. */ + "personal-access-token-sort"?: "created_at"; + /** @description A list of owner usernames to use to filter the results. */ + "personal-access-token-owner"?: string[]; + /** @description The name of the repository to use to filter the results. */ + "personal-access-token-repository"?: string; + /** @description The permission to use to filter the results. */ + "personal-access-token-permission"?: string; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "personal-access-token-before"?: string; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "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 */ + "custom-property-name": string; + /** + * @description A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + */ + "ruleset-targets"?: string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ + "ref-in-query"?: string; + /** @description The name of the repository to filter on. */ + "repository-name-in-query"?: string; + /** + * @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-server@3.15/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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-server@3.9/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. */ + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/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. */ "secret-scanning-pagination-after-org-repo"?: string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -73667,7 +77697,7 @@ export interface components { actor?: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ "workflow-run-branch"?: string; - /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ + /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/enterprise-server@3.15/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ "workflow-run-status"?: @@ -73685,7 +77715,7 @@ export interface components { | "requested" | "waiting" | "pending"; - /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ + /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: string; /** @description If `true` pull requests are omitted from the response (empty array). */ "exclude-pull-requests"?: boolean; @@ -73701,7 +77731,7 @@ export interface components { "workflow-id": number | string; /** @description The unique identifier of the autolink. */ "autolink-id": number; - /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql). */ + /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.15/graphql). */ branch: string; /** @description The unique identifier of the check run. */ "check-run-id": number; @@ -73736,6 +77766,8 @@ export interface components { "environment-name": string; /** @description The unique identifier of the branch policy. */ "branch-policy-id": number; + /** @description The unique identifier of the protection rule. */ + "protection-rule-id": number; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a @@ -73751,6 +77783,8 @@ export interface components { "key-id": number; /** @description The number that identifies the milestone. */ "milestone-number": number; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ "pull-number": number; /** @description The unique identifier of the review. */ @@ -73785,6 +77819,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred"?: "created" | "updated"; + /** @description account_id parameter */ + "account-id": number; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user"?: number; }; @@ -73860,12 +77896,12 @@ export interface operations { url: string; /** @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. */ content_type?: string; - /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers) header. */ + /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers) header. */ secret?: string; /** @description Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** */ insecure_ssl?: string; }; - /** @description The [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ + /** @description The [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. @@ -73933,12 +77969,12 @@ export interface operations { url: string; /** @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. */ content_type?: string; - /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers) header. */ + /** @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers) header. */ secret?: string; /** @description Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** */ insecure_ssl?: string; }; - /** @description The [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ + /** @description The [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`. */ events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. @@ -73959,7 +77995,7 @@ export interface operations { }; /** * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) to be sent to the webhook. */ "enterprise-admin/ping-global-webhook": { parameters: { @@ -74014,7 +78050,7 @@ export interface operations { }; /** * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. + * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ "enterprise-admin/update-ldap-mapping-for-team": { parameters: { @@ -74510,7 +78546,7 @@ export interface operations { }; /** * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * @@ -74525,7 +78561,7 @@ export interface operations { /** * @description **Required for built-in authentication.** The user's email * address. This parameter can be omitted when using CAS, LDAP, or SAML. - * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." + * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." */ email?: string; /** @@ -74547,7 +78583,7 @@ export interface operations { }; /** * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user) is often a better option. + * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#suspend-a-user) is often a better option. * * You can delete any user account except your own. */ @@ -74601,7 +78637,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description A list of [scopes](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ + /** @description A list of [scopes](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ scopes: string[]; }; }; @@ -74635,11 +78671,118 @@ export interface operations { }; }; }; + /** + * List global security advisories + * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.15/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + */ + "security-advisories/list-global-advisories": { + parameters: { + query?: { + /** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */ + ghsa_id?: string; + /** @description If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. */ + type?: "reviewed" | "malware" | "unreviewed"; + /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ + cve_id?: string; + /** @description If specified, only advisories for these ecosystems will be returned. */ + ecosystem?: components["schemas"]["security-advisory-ecosystems"]; + /** @description If specified, only advisories with these severities will be returned. */ + severity?: "unknown" | "low" | "medium" | "high" | "critical"; + /** + * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + * + * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` + */ + cwes?: string | string[]; + /** @description Whether to only return advisories that have been withdrawn. */ + is_withdrawn?: boolean; + /** + * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + * + * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + */ + affects?: string | string[]; + /** + * @description If specified, only return advisories that were published on a date or date range. + * + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + */ + published?: string; + /** + * @description If specified, only return advisories that were updated on a date or date range. + * + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + */ + updated?: string; + /** + * @description If specified, only show advisories that were updated or published on a date or date range. + * + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.15/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + */ + modified?: string; + /** + * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description The property to sort the results by. */ + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["global-advisory"][]; + }; + }; + 422: components["responses"]["validation_failed_simple"]; + /** @description Too many requests */ + 429: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + /** + * Get a global security advisory + * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + */ + "security-advisories/get-global-advisory": { + parameters: { + path: { + ghsa_id: components["parameters"]["ghsa_id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["global-advisory"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-authenticated": { responses: { @@ -74653,7 +78796,7 @@ export interface operations { }; /** * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ "apps/create-from-manifest": { parameters: { @@ -74682,7 +78825,7 @@ export interface operations { * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-webhook-config-for-app": { responses: { @@ -74698,7 +78841,7 @@ export interface operations { * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/update-webhook-config-for-app": { requestBody: { @@ -74724,14 +78867,13 @@ export interface operations { * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/list-webhook-deliveries": { parameters: { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -74749,7 +78891,7 @@ export interface operations { * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-webhook-delivery": { parameters: { @@ -74772,7 +78914,7 @@ export interface operations { * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/redeliver-webhook-delivery": { parameters: { @@ -75253,7 +79395,7 @@ export interface operations { * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-installation": { parameters: { @@ -75273,9 +79415,9 @@ export interface operations { }; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/delete-installation": { parameters: { @@ -75301,7 +79443,7 @@ export interface operations { * * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/create-installation-access-token": { parameters: { @@ -75342,7 +79484,7 @@ export interface operations { * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/suspend-installation": { parameters: { @@ -75362,7 +79504,7 @@ export interface operations { * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/unsuspend-installation": { parameters: { @@ -75381,9 +79523,10 @@ export interface operations { /** * List your grants * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ "oauth-authorizations/list-grants": { parameters: { @@ -75413,7 +79556,8 @@ export interface operations { /** * Get a single grant * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ "oauth-authorizations/get-grant": { parameters: { @@ -75436,7 +79580,8 @@ export interface operations { /** * Delete a grant * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ @@ -75458,7 +79603,7 @@ export interface operations { }; /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ "apps/delete-authorization": { @@ -75485,7 +79630,7 @@ export interface operations { }; /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -75514,7 +79659,7 @@ export interface operations { }; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -75540,7 +79685,7 @@ export interface operations { }; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -75573,10 +79718,6 @@ export interface operations { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ "apps/scope-token": { parameters: { @@ -75630,7 +79771,8 @@ export interface operations { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ "apps/get-by-slug": { parameters: { @@ -75652,7 +79794,8 @@ export interface operations { /** * List your authorizations * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ "oauth-authorizations/list-authorizations": { parameters: { @@ -75682,17 +79825,19 @@ export interface operations { /** * Create a new authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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). * - * Creates 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)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.15/rest/authentication/authenticating-to-the-rest-api#using-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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * To 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. * - * 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). + * 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.15/articles/creating-an-access-token-for-command-line-use). * - * 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. + * 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.15/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?: { @@ -75743,15 +79888,15 @@ export interface operations { /** * Get-or-create an authorization for a specific app * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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). * * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." - * - * **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/). + * 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ "oauth-authorizations/get-or-create-authorization-for-app": { parameters: { @@ -75795,7 +79940,10 @@ export interface operations { "application/json": components["schemas"]["authorization"]; }; }; - /** @description **Deprecation Notice:** GitHub 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/apps/building-oauth-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/). */ + /** + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). + */ 201: { headers: { /** @example https://api.github.com/authorizations/1 */ @@ -75814,13 +79962,15 @@ export interface operations { /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * **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). + * > [!WARNING] + * > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/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). * * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * 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)." + * 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { parameters: { @@ -75879,7 +80029,8 @@ export interface operations { /** * Get a single authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ "oauth-authorizations/get-authorization": { parameters: { @@ -75902,7 +80053,8 @@ export interface operations { /** * Delete an authorization * @deprecated - * @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/apps/building-oauth-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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). */ "oauth-authorizations/delete-authorization": { parameters: { @@ -75923,9 +80075,10 @@ export interface operations { /** * Update an existing authorization * @deprecated - * @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/). + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/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/). * - * 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)." + * 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.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * * You can only send one of these scope keys at a time. */ @@ -76191,6 +80344,22 @@ export interface operations { }; }; }; + /** + * Get security products statistics + * @description Gets the statistics about security products for a GitHub Enterprise Server instance. + * + * To use this endpoint, you must be a site admin. + */ + "enterprise-admin/get-security-products": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["enterprise-security-products-overview"]; + }; + }; + }; + }; /** Get users statistics */ "enterprise-admin/get-user-stats": { responses: { @@ -76467,7 +80636,7 @@ export interface operations { * Get default workflow permissions for an enterprise * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -76490,7 +80659,7 @@ export interface operations { * Set default workflow permissions for an enterprise * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets * whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ @@ -76891,6 +81060,8 @@ export interface operations { "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { query?: { + /** @description The name of a self-hosted runner. */ + name?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; }; @@ -76934,6 +81105,41 @@ export interface operations { }; }; }; + /** + * Create configuration for a just-in-time runner for an Enterprise + * @description Generates a configuration that can be passed to the runner application at startup. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + */ + "actions/generate-runner-jitconfig-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the new runner. */ + name: string; + /** @description The ID of the runner group to register the runner to. */ + runner_group_id: number; + /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */ + labels: string[]; + /** + * @description The working directory to be used for job execution, relative to the runner install directory. + * @default _work + */ + work_folder?: string; + }; + }; + }; + responses: { + 201: components["responses"]["actions_runner_jitconfig"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; /** * Create a registration token for an enterprise * @description Returns a token that you can pass to the `config` script. The token expires after one hour. @@ -77186,7 +81392,7 @@ export interface operations { }; /** * List code scanning alerts for an enterprise - * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be a member of the enterprise to use this endpoint. * @@ -77231,7 +81437,7 @@ export interface operations { * * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ "secret-scanning/get-security-analysis-settings-for-enterprise": { parameters: { @@ -77266,19 +81472,25 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.9/get-started/learning-about-github/about-github-advanced-security)." */ + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.15/get-started/learning-about-github/about-github-advanced-security)." */ advanced_security_enabled_for_new_repositories?: boolean; - /** @description Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." */ + /** @description Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.15/get-started/learning-about-github/about-github-advanced-security)." */ + advanced_security_enabled_new_user_namespace_repos?: boolean; + /** @description Whether Dependabot alerts are automatically enabled for new repositories. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." */ + /** @description Whether secret scanning is automatically enabled for new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning)." */ secret_scanning_enabled_for_new_repositories?: boolean; - /** @description Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ + /** @description Whether secret scanning push protection is automatically enabled for new repositories. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** - * @description The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * @description The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; + /** @description Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise. */ + secret_scanning_non_provider_patterns_enabled_for_new_repositories?: + | boolean + | null; }; }; }; @@ -77300,7 +81512,7 @@ export interface operations { * * The authenticated user must be a member of the enterprise to use this endpoint. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ @@ -77340,7 +81552,7 @@ export interface operations { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. */ "secret-scanning/list-alerts-for-enterprise": { parameters: { @@ -77353,6 +81565,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { enterprise: components["parameters"]["enterprise"]; @@ -77397,7 +81610,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -77430,7 +81642,8 @@ export interface operations { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-public-events": { parameters: { @@ -77456,16 +81669,17 @@ export interface operations { * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.15/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -77507,7 +81721,8 @@ export interface operations { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ "gists/create": { requestBody: { @@ -77557,7 +81772,7 @@ export interface operations { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ "gists/list-public": { parameters: { @@ -77613,7 +81828,7 @@ export interface operations { * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -77709,7 +81924,7 @@ export interface operations { * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -77743,7 +81958,7 @@ export interface operations { * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -77785,7 +82000,7 @@ export interface operations { * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -77831,7 +82046,7 @@ export interface operations { * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -77965,7 +82180,7 @@ export interface operations { }; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "gists/star": { parameters: { @@ -78004,7 +82219,7 @@ export interface operations { * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. @@ -78030,7 +82245,7 @@ export interface operations { }; /** * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-the-authenticated-user). + * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ "gitignore/get-all-templates": { responses: { @@ -78047,7 +82262,7 @@ export interface operations { * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ @@ -78102,7 +82317,7 @@ export interface operations { * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ "apps/revoke-installation-access-token": { responses: { @@ -78118,12 +82333,10 @@ export interface operations { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -78173,7 +82386,7 @@ export interface operations { }; /** * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ "licenses/get-all-commonly-used": { parameters: { @@ -78195,7 +82408,7 @@ export interface operations { }; /** * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ "licenses/get": { parameters: { @@ -78215,9 +82428,382 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get the configured SSH keys + * @description Gets the configured SSH keys on all available nodes. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/get-manage-ssh": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-ssh"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Set a new SSH key + * @description Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise Server instance. This will grant access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/set-manage-ssh": { + requestBody: { + content: { + "application/json": components["schemas"]["ghes-set-ssh-request"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-set-ssh-response"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Delete a SSH key + * @description Deletes a SSH key from the `authorized_keys` file for your GitHub Enterprise Server instance. This will remove access via SSH to your instance. For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + */ + "enterprise-admin/delete-manage-ssh": { + requestBody: { + content: { + "application/json": components["schemas"]["ghes-delete-ssh-request"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-delete-ssh-response"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the system requirement check results for configured cluster nodes + * @description Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + * This endpoint may take several seconds to reply. + */ + "enterprise-admin/get-checks-system-requirements": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-checks-system-requirements"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of services running on all cluster nodes + * @description Gets the status of all services running on each cluster node. + * This endpoint may take several seconds to reply. + */ + "enterprise-admin/get-cluster-status": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-cluster-status"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of a ghe-config-apply run + * @description Displays the current status of `ghe-config-apply` in the environment or the status of a historical run by ID. + */ + "enterprise-admin/get-manage-config-apply-status": { + parameters: { + query?: { + /** @description The unique run ID of the `ghe-config-apply` run. */ + run_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Whether the ghe-config-apply run is still running in the environment */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful in the environment */ + successful?: boolean; + nodes?: { + /** @description The unique Run ID of the ghe-config-apply run on the host */ + run_id?: string; + /** @description The hostname of the node */ + hostname?: string; + /** @description Whether the ghe-config-apply run is still running on the host */ + running?: boolean; + /** @description Whether the ghe-config-apply run was successful on the host */ + successful?: boolean; + }[]; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Trigger a ghe-config-apply run + * @description Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + * You can provide a run ID or allow one to be generated randomly. + */ + "enterprise-admin/post-manage-run-config-apply": { + requestBody?: { + content: { + "application/json": { + /** @description The run ID to execute `ghe-config-apply` with. If not provided, a run ID will be generated randomly. */ + run_id?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + /** @description Run ID the job was launched with */ + run_id?: string; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * List events from ghe-config-apply + * @description Lists events from an in-process `ghe-config-apply` run on your Github Enterprise Server instance. + */ + "enterprise-admin/get-manage-config-apply-events": { + parameters: { + query?: { + /** @description The unique ID of the last response from a host, used for pagination. */ + last_request_id?: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + nodes?: { + /** @description Hostname of the node */ + node?: string; + /** @description Unique ID of the last response from a host used for pagination */ + last_request_id?: string; + events?: { + timestamp?: string; + severity_text?: string; + body?: string; + event_name?: string; + topology?: string; + hostname?: string; + config_run_id?: string; + trace_id?: string; + span_id?: string; + span_parent_id?: string; + span_depth?: number; + }[]; + }[]; + }; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Initialize instance configuration with license and password + * @description When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + * + * > [!IMPORTANT] + * > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + * + * The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + "enterprise-admin/initialize-instance-configuration": { + requestBody: { + content: { + "multipart/form-data": components["schemas"]["ghes-config-init-request"]; + }; + }; + responses: { + /** @description Response */ + 202: { + content: never; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the enterprise license information + * @description Gets information about the license that is currently set for the enterprise. + */ + "enterprise-admin/license-info": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-license-info"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Upload an enterprise license + * @description Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + * + * > [!NOTE] + * > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + */ + "enterprise-admin/license-upload": { + parameters: { + query?: { + apply?: components["parameters"]["license-apply"]; + }; + }; + requestBody: { + content: { + "multipart/form-data": components["schemas"]["ghes-upload-license-request"]; + }; + }; + responses: { + /** @description Created */ + 201: { + content: never; + }; + /** @description Accepted */ + 202: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Check a license + * @description Check the status of the license that is currently set for the enterprise. + */ + "enterprise-admin/license-check": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-license-check"]; + }; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; /** * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering)." + * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.15/admin/enterprise-management/configuring-clustering/about-clustering)." */ "enterprise-admin/get-config-nodes": { parameters: { @@ -78243,6 +82829,125 @@ export interface operations { }; }; }; + /** + * Get the GHES settings + * @description Gets a list of settings for a GitHub Enterprise Server instance. + */ + "enterprise-admin/get-manage-settings": { + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-settings"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + }; + }; + /** + * Set settings + * @description Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-settings). + * + * **Notes:** + * - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + * - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + */ + "enterprise-admin/set-manage-settings": { + /** @description Only the settings parameters that should be modified need to be specified. */ + requestBody: { + content: { + "application/json": Record; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Get the status of maintenance mode + * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + */ + "enterprise-admin/get-manage-maintenance": { + parameters: { + query?: { + uuid?: components["parameters"]["uuid"]; + cluster_roles?: components["parameters"]["cluster-roles"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-get-maintenance"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; + /** + * Set the status of maintenance mode + * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + */ + "enterprise-admin/set-manage-maintenance": { + requestBody: { + content: { + "application/json": components["schemas"]["ghes-set-maintenance-request"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["ghes-set-maintenance-response"]; + }; + }; + /** @description Bad request */ + 400: { + content: never; + }; + /** @description Unauthorized */ + 401: { + content: never; + }; + /** @description Internal error */ + 500: { + content: never; + }; + }; + }; /** * Get the status of services running on all replica nodes * @description Gets the status of all services running on each replica node. @@ -78274,7 +82979,7 @@ export interface operations { }; /** * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.9/admin/all-releases)." + * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.15/admin/all-releases)." */ "enterprise-admin/get-version": { parameters: { @@ -78371,7 +83076,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-repo-network": { parameters: { query?: { @@ -78408,7 +83117,7 @@ export interface operations { since?: components["parameters"]["since"]; before?: components["parameters"]["before"]; page?: components["parameters"]["page"]; - /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; }; @@ -78430,7 +83139,7 @@ export interface operations { }; /** * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ "activity/mark-notifications-as-read": { requestBody?: { @@ -78486,6 +83195,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: https://github.com/notifications. + */ + "activity/mark-thread-as-done": { + parameters: { + path: { + thread_id: components["parameters"]["thread-id"]; + }; + }; + responses: { + /** @description No content */ + 204: { + content: never; + }; + }; + }; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. @@ -78507,7 +83233,7 @@ export interface operations { }; /** * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription). + * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#get-a-repository-subscription). * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ @@ -78535,7 +83261,7 @@ export interface operations { * * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ "activity/set-thread-subscription": { parameters: { @@ -78568,7 +83294,7 @@ export interface operations { }; /** * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ "activity/delete-thread-subscription": { parameters: { @@ -78610,7 +83336,8 @@ export interface operations { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ "orgs/list": { parameters: { @@ -78634,12 +83361,12 @@ export interface operations { }; }; /** - * Deprecated - List custom repository roles in an organization + * Closing down - List custom repository roles in an organization * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * @@ -78672,21 +83399,10 @@ export interface operations { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.15/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. @@ -78715,7 +83431,7 @@ export interface operations { * * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.15/site-policy/github-terms/github-terms-of-service */ "orgs/delete": { parameters: { @@ -78731,20 +83447,13 @@ export interface operations { }; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * @description > [!WARNING] + * > **Closing down notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down and will be replaced with code security configurations in a future GitHub Enterprise Server version. * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -78788,15 +83497,15 @@ export interface operations { * @default true */ members_can_create_repositories?: boolean; - /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_internal_repositories?: boolean; - /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_private_repositories?: boolean; - /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ + /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -78818,49 +83527,67 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. + * + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. + * + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. + * + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ @@ -79195,7 +83922,7 @@ export interface operations { * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -79218,7 +83945,7 @@ export interface operations { * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions * can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -79625,6 +84352,8 @@ export interface operations { "actions/list-self-hosted-runners-for-org": { parameters: { query?: { + /** @description The name of a self-hosted runner. */ + name?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; }; @@ -79670,6 +84399,43 @@ export interface operations { }; }; }; + /** + * Create configuration for a just-in-time runner for an organization + * @description Generates a configuration that can be passed to the runner application at startup. + * + * The authenticated user must have admin access to the organization. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "actions/generate-runner-jitconfig-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the new runner. */ + name: string; + /** @description The ID of the runner group to register the runner to. */ + runner_group_id: number; + /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */ + labels: string[]; + /** + * @description The working directory to be used for job execution, relative to the runner install directory. + * @default _work + */ + work_folder?: string; + }; + }; + }; + responses: { + 201: components["responses"]["actions_runner_jitconfig"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. @@ -80155,7 +84921,7 @@ export interface operations { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -80171,7 +84937,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -80187,7 +84953,7 @@ export interface operations { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -80216,7 +84982,7 @@ export interface operations { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#create-or-update-an-organization-secret). * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -80592,11 +85358,11 @@ export interface operations { }; /** * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api)." * * The authenticated user must be an organization owner to use this endpoint. * @@ -80628,7 +85394,7 @@ export interface operations { }; /** * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an owner or security manager for the organization to use this endpoint. * @@ -80669,9 +85435,533 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error. + */ + "code-security/create-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph. Dependency Graph is not configurable in GitHub Enterprise Server. + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + "code-security/get-default-configurations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/detach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + "code-security/get-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/delete-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error. + */ + "code-security/update-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph. Dependency Graph is not configurable in GitHub Enterprise Server. + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + content: never; + }; + }; + }; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/attach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: + | "all" + | "all_without_configurations" + | "public" + | "private_or_internal" + | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * + * > [!NOTE] + * > The enablement status will only be returned for installed security products. + */ + "code-security/set-configuration-as-default": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-repositories-for-configuration": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; + }; + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -80701,7 +85991,7 @@ export interface operations { }; /** * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -80731,7 +86021,7 @@ export interface operations { }; /** * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -80757,7 +86047,7 @@ export interface operations { /** * Delete a custom repository role * @description Deletes a custom role from an organization. Once the custom role has been deleted, any - * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -80779,7 +86069,7 @@ export interface operations { }; /** * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -81095,7 +86385,7 @@ export interface operations { * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -81109,7 +86399,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -81125,7 +86415,7 @@ export interface operations { * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -81152,7 +86442,7 @@ export interface operations { * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * or update an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#create-or-update-an-organization-secret). * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -81198,7 +86488,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-org-events": { parameters: { query?: { @@ -81222,10 +86516,14 @@ export interface operations { * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/external-idp-group-info-for-org": { parameters: { + query?: { + per_page?: components["parameters"]["members-per-page"]; + page?: components["parameters"]["members-page"]; + }; path: { org: components["parameters"]["org"]; group_id: components["parameters"]["group-id"]; @@ -81244,7 +86542,7 @@ export interface operations { * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/list-external-idp-groups-for-org": { parameters: { @@ -81274,7 +86572,9 @@ export interface operations { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -81334,7 +86634,7 @@ export interface operations { password?: string; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ * "push" * ] @@ -81392,7 +86692,9 @@ export interface operations { }; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -81443,7 +86745,7 @@ export interface operations { insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for. * @default [ * "push" * ] @@ -81544,7 +86846,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -81615,7 +86916,7 @@ export interface operations { }; /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) * to be sent to the hook. * * You must be an organization owner to use this endpoint. @@ -81642,7 +86943,7 @@ export interface operations { * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-org-installation": { parameters: { @@ -81697,12 +86998,10 @@ export interface operations { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -81853,13 +87152,13 @@ export interface operations { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.15/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ "orgs/set-membership-for-user": { parameters: { @@ -81949,7 +87248,7 @@ 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)." + * 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.15/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: { @@ -82095,7 +87394,7 @@ export interface operations { }; /** * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ "migrations/unlock-repo-for-org": { parameters: { @@ -82141,6 +87440,438 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-organization-fine-grained-permissions": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-org-roles": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response - list of organization roles */ + 200: { + content: { + "application/json": { + /** @description The total number of organization roles available to the organization. */ + total_count?: number; + /** @description The list of organization roles available to the organization. */ + roles?: components["schemas"]["organization-role"][]; + }; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific + * permissions over the organization and optionally across all repositories in the organization. For + * more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To include repository permissions in an organization role, you must also include the `base_role` + * field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of + * fine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions + * and can only be granted through the base role (like "reading a repo"). If you include repository permissions, those + * permissions apply across all of the repositories in the organization. You do not have to include organization permissions + * in order to add repository permissions. + * + * See "[List repository permissions](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/create-custom-organization-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-custom-organization-role-create-schema"]; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Remove all organization roles for a team + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-all-org-roles-team": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/assign-team-to-org-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + /** @description Response if the organization, team or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ + 422: { + content: never; + }; + }; + }; + /** + * Remove an organization role from a team + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-org-role-team": { + parameters: { + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-all-org-roles-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/assign-user-to-org-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + /** @description Response if the organization, user or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ + 422: { + content: never; + }; + }; + }; + /** + * Remove an organization role from a user + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/revoke-org-role-user": { + parameters: { + path: { + org: components["parameters"]["org"]; + username: components["parameters"]["username"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/get-org-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/delete-custom-organization-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either + * previously or as part of the update. + * If the update sets the `base_role` field to `none`, you must also remove all of the repository + * permissions as well, otherwise the update will fail. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/patch-custom-organization-role": { + parameters: { + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-custom-organization-role-update-schema"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * List teams that are assigned to an organization role + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-org-role-teams": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response - List of assigned teams */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["team-role-assignment"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + content: never; + }; + }; + }; + /** + * List users that are assigned to an organization role + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + * + * To use this endpoint, you must be an administrator for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-org-role-users": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** @description Response - List of assigned users */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["user-role-assignment"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + 404: { + content: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + content: never; + }; + }; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. @@ -82171,7 +87902,7 @@ export interface operations { }; /** * Convert an organization member to outside collaborator - * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.9/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.15/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ "orgs/convert-member-to-outside-collaborator": { parameters: { @@ -82202,7 +87933,7 @@ export interface operations { 204: { content: never; }; - /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ + /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ 403: { content: never; }; @@ -82240,7 +87971,7 @@ export interface operations { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-organization": { parameters: { @@ -82254,9 +87985,9 @@ export interface operations { | "nuget" | "container"; visibility?: components["parameters"]["package-visibility"]; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; - /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; path: { @@ -82279,7 +88010,7 @@ export interface operations { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-organization": { parameters: { @@ -82302,9 +88033,9 @@ export interface operations { * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-org": { parameters: { @@ -82332,9 +88063,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-org": { parameters: { @@ -82362,7 +88093,7 @@ export interface operations { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { @@ -82394,7 +88125,7 @@ export interface operations { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-organization": { parameters: { @@ -82418,9 +88149,9 @@ export interface operations { * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-org": { parameters: { @@ -82449,9 +88180,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-org": { parameters: { @@ -82472,6 +88203,285 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List requests to access organization resources with fine-grained personal access tokens + * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/list-pat-grant-requests": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + sort?: components["parameters"]["personal-access-token-sort"]; + direction?: components["parameters"]["direction"]; + owner?: components["parameters"]["personal-access-token-owner"]; + repository?: components["parameters"]["personal-access-token-repository"]; + permission?: components["parameters"]["personal-access-token-permission"]; + last_used_before?: components["parameters"]["personal-access-token-before"]; + last_used_after?: components["parameters"]["personal-access-token-after"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Review requests to access organization resources with fine-grained personal access tokens + * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/review-pat-grant-requests-in-bulk": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ + pat_request_ids?: number[]; + /** + * @description Action to apply to the requests. + * @enum {string} + */ + action: "approve" | "deny"; + /** @description Reason for approving or denying the requests. Max 1024 characters. */ + reason?: string | null; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Review a request to access organization resources with a fine-grained personal access token + * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/review-pat-grant-request": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** @description Unique identifier of the request for access via fine-grained personal access token. */ + pat_request_id: number; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Action to apply to the request. + * @enum {string} + */ + action: "approve" | "deny"; + /** @description Reason for approving or denying the request. Max 1024 characters. */ + reason?: string | null; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * List repositories requested to be accessed by a fine-grained personal access token + * @description Lists the repositories a fine-grained personal access token request is requesting access to. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/list-pat-grant-request-repositories": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + /** @description Unique identifier of the request for access via fine-grained personal access token. */ + pat_request_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * List fine-grained personal access tokens with access to organization resources + * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/list-pat-grants": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + sort?: components["parameters"]["personal-access-token-sort"]; + direction?: components["parameters"]["direction"]; + owner?: components["parameters"]["personal-access-token-owner"]; + repository?: components["parameters"]["personal-access-token-repository"]; + permission?: components["parameters"]["personal-access-token-permission"]; + last_used_before?: components["parameters"]["personal-access-token-before"]; + last_used_after?: components["parameters"]["personal-access-token-after"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["organization-programmatic-access-grant"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Update the access to organization resources via fine-grained personal access tokens + * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/update-pat-accesses": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Action to apply to the fine-grained personal access token. + * @enum {string} + */ + action: "revoke"; + /** @description The IDs of the fine-grained personal access tokens. */ + pat_ids: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Update the access a fine-grained personal access token has to organization resources + * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/update-pat-access": { + parameters: { + path: { + org: components["parameters"]["org"]; + pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Action to apply to the fine-grained personal access token. + * @enum {string} + */ + action: "revoke"; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * List repositories a fine-grained personal access token has access to + * @description Lists the repositories a fine-grained personal access token has access to. + * + * Only GitHub Apps can use this endpoint. + */ + "orgs/list-pat-grant-repositories": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + /** @description Unique identifier of the fine-grained personal access token. */ + pat_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * List pre-receive hooks for an organization * @description List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. @@ -82628,6 +88638,206 @@ 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. + * Organization members can read these properties. + */ + "orgs/get-all-custom-properties": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "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"]["custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * Organization members can read these properties. + */ + "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"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "orgs/create-or-update-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + requestBody: { + content: { + "application/json": components["schemas"]["custom-property-set-payload"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + */ + "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"]; + /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.15/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + repository_query?: string; + }; + 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. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + */ + "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 No Content when custom property values are successfully created or updated */ + 204: { + content: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. @@ -82680,7 +88890,7 @@ export interface operations { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "orgs/set-public-membership-for-authenticated-user": { parameters: { @@ -82719,7 +88929,8 @@ export interface operations { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/list-for-org": { parameters: { @@ -82783,7 +88994,7 @@ export interface operations { */ private?: boolean; /** - * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.9/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. + * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.15/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. * @enum {string} */ @@ -82823,7 +89034,7 @@ export interface operations { auto_init?: boolean; /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ gitignore_template?: string; - /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.9/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ + /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.15/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ license_template?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. @@ -82852,12 +89063,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -82874,7 +89087,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -82890,6 +89105,10 @@ export interface operations { * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; }; }; @@ -82910,7 +89129,7 @@ export interface operations { }; /** * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * @@ -82931,6 +89150,223 @@ export interface operations { }; }; }; + /** + * Get all organization repository rulesets + * @description Get all the repository rulesets for an organization. + */ + "repos/get-org-rulesets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Create an organization repository ruleset + * @description Create a repository ruleset for an organization. + */ + "repos/create-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + /** @description Request body */ + requestBody: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name: string; + /** + * @description The target of the ruleset. + * @default branch + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + /** + * @description The type of the source of the ruleset + * @enum {string} + */ + source_type?: "Repository" | "Organization"; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 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-server@3.15/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + "repos/get-org-rule-suites": { + parameters: { + query?: { + ref?: components["parameters"]["ref-in-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-server@3.15/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. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + "repos/get-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Update an organization repository ruleset + * @description Update a ruleset for an organization. + */ + "repos/update-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + /** @description Request body */ + requestBody?: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name?: string; + /** + * @description The target of the ruleset. + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Delete an organization repository ruleset + * @description Delete a ruleset for an organization. + */ + "repos/delete-org-ruleset": { + parameters: { + path: { + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. @@ -82951,6 +89387,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { org: components["parameters"]["org"]; @@ -82972,7 +89409,7 @@ export interface operations { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * @@ -82995,7 +89432,7 @@ export interface operations { }; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -83013,15 +89450,11 @@ export interface operations { 204: { content: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - content: never; - }; }; }; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -83068,7 +89501,6 @@ export interface operations { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; }; }; /** @@ -83100,9 +89532,9 @@ export interface operations { }; /** * Create a team - * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.9/articles/setting-team-creation-permissions-in-your-organization)." + * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/enterprise-server@3.15/articles/setting-team-creation-permissions-in-your-organization)." * - * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/about-teams)". + * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ "teams/create": { parameters: { @@ -83134,14 +89566,24 @@ export interface operations { */ privacy?: "secret" | "closed"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description The notification setting the team has chosen. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` + * @enum {string} + */ + notification_setting?: + | "notifications_enabled" + | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ permission?: "pull" | "push"; /** @description The ID of a team to set as the parent team. */ parent_team_id?: number; - /** @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the "[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" endpoint to change the LDAP DN. For more information, see "[Using LDAP](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." */ + /** @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the "[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" endpoint to change the LDAP DN. For more information, see "[Using LDAP](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." */ ldap_dn?: string; }; }; @@ -83161,7 +89603,8 @@ export interface operations { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ "teams/get-by-name": { parameters: { @@ -83186,7 +89629,8 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ "teams/delete-in-org": { parameters: { @@ -83206,7 +89650,8 @@ export interface operations { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ "teams/update-in-org": { parameters: { @@ -83233,7 +89678,16 @@ export interface operations { */ privacy?: "secret" | "closed"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: + | "notifications_enabled" + | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -83265,7 +89719,8 @@ export interface operations { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -83299,9 +89754,10 @@ export interface operations { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83340,7 +89796,8 @@ export interface operations { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -83365,7 +89822,8 @@ export interface operations { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83388,7 +89846,8 @@ export interface operations { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83423,7 +89882,8 @@ export interface operations { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -83456,9 +89916,10 @@ export interface operations { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83491,7 +89952,8 @@ export interface operations { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -83517,7 +89979,8 @@ export interface operations { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83541,7 +90004,8 @@ export interface operations { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83573,16 +90037,17 @@ export interface operations { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: | "+1" | "-1" @@ -83616,11 +90081,12 @@ export interface operations { }; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83637,7 +90103,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: @@ -83669,9 +90135,10 @@ export interface operations { }; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83694,16 +90161,17 @@ export interface operations { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: | "+1" | "-1" @@ -83736,11 +90204,12 @@ export interface operations { }; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83756,7 +90225,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: @@ -83788,9 +90257,10 @@ export interface operations { }; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -83814,7 +90284,7 @@ export interface operations { * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/list-linked-external-idp-groups-to-team-for-org": { parameters: { @@ -83836,7 +90306,7 @@ export interface operations { * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { @@ -83856,7 +90326,7 @@ export interface operations { * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ "teams/link-external-idp-group-to-team-for-org": { parameters: { @@ -83922,12 +90392,13 @@ export interface operations { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#create-a-team). */ "teams/get-membership-for-user-in-org": { parameters: { @@ -83954,15 +90425,17 @@ export interface operations { * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -84005,11 +90478,13 @@ export interface operations { * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -84034,7 +90509,8 @@ export interface operations { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ "teams/list-projects-in-org": { parameters: { @@ -84063,7 +90539,8 @@ export interface operations { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -84090,7 +90567,8 @@ export interface operations { * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -84104,7 +90582,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -84131,7 +90609,8 @@ export interface operations { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/remove-project-in-org": { parameters: { @@ -84152,7 +90631,8 @@ export interface operations { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ "teams/list-repos-in-org": { parameters: { @@ -84181,13 +90661,14 @@ export interface operations { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/check-permissions-for-repo-in-org": { parameters: { @@ -84217,11 +90698,12 @@ export interface operations { }; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * - * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ "teams/add-or-update-repo-permissions-in-org": { parameters: { @@ -84235,10 +90717,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -84254,7 +90733,8 @@ export interface operations { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/remove-repo-in-org": { parameters: { @@ -84276,7 +90756,8 @@ export interface operations { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ "teams/list-child-in-org": { parameters: { @@ -84303,11 +90784,15 @@ export interface operations { }; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -84317,6 +90802,18 @@ export interface operations { enablement: components["parameters"]["org-security-product-enablement"]; }; }; + requestBody?: { + content: { + "application/json": { + /** + * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @enum {string} + */ + query_suite?: "default" | "extended"; + }; + }; + }; responses: { /** @description Action started */ 204: { @@ -84985,20 +91482,22 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.9/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.9/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.9/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.9/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.15/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.15/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.15/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.15/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.15/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.15/rest/about-the-rest-api/api-versions)." + * + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { responses: { @@ -85021,7 +91520,8 @@ export interface operations { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/get": { parameters: { @@ -85078,7 +91578,7 @@ export interface operations { }; /** * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics) endpoint. + * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#replace-all-repository-topics) endpoint. */ "repos/update": { parameters: { @@ -85098,7 +91598,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.15/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -85110,7 +91610,7 @@ export interface operations { /** * @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. @@ -85133,6 +91633,11 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -85183,12 +91688,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -85205,7 +91712,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -85783,8 +92292,8 @@ export interface operations { * Get the level of access for workflows outside of the repository * @description Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -85808,8 +92317,8 @@ export interface operations { * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. * This endpoint only applies to internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -85887,7 +92396,7 @@ export interface operations { * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -85911,7 +92420,7 @@ export interface operations { * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -85949,6 +92458,8 @@ export interface operations { "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { + /** @description The name of a self-hosted runner. */ + name?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; }; @@ -85996,6 +92507,44 @@ export interface operations { }; }; }; + /** + * 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. + * + * The authenticated user must have admin access to the repository. + * + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + */ + "actions/generate-runner-jitconfig-for-repo": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the new runner. */ + name: string; + /** @description The ID of the runner group to register the runner to. */ + runner_group_id: number; + /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */ + labels: string[]; + /** + * @description The working directory to be used for job execution, relative to the runner install directory. + * @default _work + */ + work_folder?: string; + }; + }; + }; + responses: { + 201: components["responses"]["actions_runner_jitconfig"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. @@ -86237,13 +92786,13 @@ export interface operations { }; /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs-for-repo": { parameters: { @@ -86421,7 +92970,7 @@ export interface operations { /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -86509,10 +93058,66 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; + /** + * Review custom deployment protection rules for a workflow run + * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + "actions/review-custom-gates-for-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + requestBody: { + content: { + "application/json": + | components["schemas"]["review-custom-gates-comment-required"] + | components["schemas"]["review-custom-gates-state-required"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * 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). + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope 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. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint. * @@ -86829,7 +93434,7 @@ export interface operations { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -86846,7 +93451,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -87177,11 +93782,13 @@ export interface operations { }; /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#parameters). * * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs": { parameters: { @@ -87218,9 +93825,68 @@ export interface operations { }; }; }; + /** + * 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. + * + * For more information about viewing repository activity, + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.15/repositories/viewing-activity-and-data-for-your-repository)." + */ + "repos/list-activities": { + parameters: { + query?: { + direction?: components["parameters"]["direction"]; + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description The Git reference for the activities you want to list. + * + * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. + */ + ref?: string; + /** @description The GitHub username to use to filter by the actor who performed the activity. */ + actor?: string; + /** + * @description The time period to filter by. + * + * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). + */ + time_period?: "day" | "week" | "month" | "quarter" | "year"; + /** + * @description The activity type to filter by. + * + * For example, you can choose to filter by "force_push", to see all force pushes to the repository. + */ + activity_type?: + | "push" + | "force_push" + | "branch_creation" + | "branch_deletion" + | "pr_merge" + | "merge_queue_merge"; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["activity"][]; + }; + }; + 422: components["responses"]["validation_failed_simple"]; + }; + }; /** * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.9/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.15/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ "issues/list-assignees": { parameters: { @@ -87383,11 +94049,35 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Check if automated security fixes are enabled for a repository + * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.15/articles/configuring-automated-security-fixes)". + */ + "repos/check-automated-security-fixes": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response if Dependabot is enabled */ + 200: { + content: { + "application/json": components["schemas"]["check-automated-security-fixes"]; + }; + }; + /** @description Not Found if Dependabot is not enabled for the repository */ + 404: { + content: never; + }; + }; + }; /** List branches */ "repos/list-branches": { parameters: { query?: { - /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -87432,7 +94122,7 @@ export interface operations { }; /** * Get branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-branch-protection": { parameters: { @@ -87454,13 +94144,15 @@ export interface operations { }; /** * Update branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ "repos/update-branch-protection": { parameters: { @@ -87479,7 +94171,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -87505,7 +94197,7 @@ export interface operations { }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ dismiss_stale_reviews?: boolean; - /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.9/articles/about-code-owners/) review them. */ + /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.15/articles/about-code-owners/) review them. */ require_code_owner_reviews?: boolean; /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ required_approving_review_count?: number; @@ -87533,11 +94225,11 @@ export interface operations { /** @description The list of app `slug`s with push access */ apps?: string[]; } | null; - /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ + /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ required_linear_history?: boolean; - /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ + /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ allow_force_pushes?: boolean | null; - /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ + /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ allow_deletions?: boolean; /** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */ block_creations?: boolean; @@ -87570,7 +94262,7 @@ export interface operations { }; /** * Delete branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/delete-branch-protection": { parameters: { @@ -87590,7 +94282,7 @@ export interface operations { }; /** * Get admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-admin-branch-protection": { parameters: { @@ -87611,7 +94303,7 @@ export interface operations { }; /** * Set admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -87634,7 +94326,7 @@ export interface operations { }; /** * Delete admin branch protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -87656,7 +94348,7 @@ export interface operations { }; /** * Get pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-pull-request-review-protection": { parameters: { @@ -87677,7 +94369,7 @@ export interface operations { }; /** * Delete pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/delete-pull-request-review-protection": { parameters: { @@ -87697,11 +94389,12 @@ export interface operations { }; /** * Update pull request review protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ "repos/update-pull-request-review-protection": { parameters: { @@ -87725,7 +94418,7 @@ export interface operations { }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ dismiss_stale_reviews?: boolean; - /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.9/articles/about-code-owners/) have reviewed. */ + /** @description Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.15/articles/about-code-owners/) have reviewed. */ require_code_owner_reviews?: boolean; /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ required_approving_review_count?: number; @@ -87758,11 +94451,12 @@ export interface operations { }; /** * Get commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.9/articles/signing-commits-with-gpg) in GitHub Help. + * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.15/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ "repos/get-commit-signature-protection": { parameters: { @@ -87784,7 +94478,7 @@ export interface operations { }; /** * Create commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -87808,7 +94502,7 @@ export interface operations { }; /** * Delete commit signature protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ @@ -87830,7 +94524,7 @@ export interface operations { }; /** * Get status checks protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-status-checks-protection": { parameters: { @@ -87852,7 +94546,7 @@ export interface operations { }; /** * Remove status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/remove-status-check-protection": { parameters: { @@ -87871,7 +94565,7 @@ export interface operations { }; /** * Update status check protection - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ @@ -87890,7 +94584,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -87916,7 +94610,7 @@ export interface operations { }; /** * Get all status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/get-all-status-check-contexts": { parameters: { @@ -87938,7 +94632,7 @@ export interface operations { }; /** * Set status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/set-status-check-contexts": { parameters: { @@ -87969,7 +94663,7 @@ export interface operations { }; /** * Add status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/add-status-check-contexts": { parameters: { @@ -88001,7 +94695,7 @@ export interface operations { }; /** * Remove status check contexts - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ "repos/remove-status-check-contexts": { parameters: { @@ -88032,11 +94726,12 @@ export interface operations { }; /** * Get access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ "repos/get-access-restrictions": { parameters: { @@ -88058,7 +94753,7 @@ export interface operations { }; /** * Delete access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ @@ -88079,7 +94774,7 @@ export interface operations { }; /** * Get apps with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -88103,7 +94798,7 @@ export interface operations { }; /** * Set app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -88115,7 +94810,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -88135,7 +94830,7 @@ export interface operations { }; /** * Add app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -88147,7 +94842,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -88167,7 +94862,7 @@ export interface operations { }; /** * Remove app access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ @@ -88179,7 +94874,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -88199,7 +94894,7 @@ export interface operations { }; /** * Get teams with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the teams who have push access to this branch. The list includes child teams. */ @@ -88223,7 +94918,7 @@ export interface operations { }; /** * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ @@ -88255,7 +94950,7 @@ export interface operations { }; /** * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ @@ -88287,7 +94982,7 @@ export interface operations { }; /** * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ @@ -88319,7 +95014,7 @@ export interface operations { }; /** * Get users with access to the protected branch - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists the people who have push access to this branch. */ @@ -88343,7 +95038,7 @@ export interface operations { }; /** * Set user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. * @@ -88359,7 +95054,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -88379,7 +95074,7 @@ export interface operations { }; /** * Add user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified people push access for this branch. * @@ -88395,7 +95090,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -88415,7 +95110,7 @@ export interface operations { }; /** * Remove user access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a user to push to this branch. * @@ -88431,7 +95126,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -88453,7 +95148,8 @@ export interface operations { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/enterprise-server@3.15/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -88610,7 +95306,8 @@ export interface operations { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -88635,7 +95332,8 @@ export interface operations { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -88699,7 +95397,7 @@ export interface operations { summary: string; /** @description Can contain Markdown. */ text?: string; - /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.9/articles/about-status-checks#checks)". */ + /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.15/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.15/articles/about-status-checks#checks)". */ annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ path: string; @@ -88733,7 +95431,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.15/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -88797,9 +95495,9 @@ export interface operations { }; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -88835,9 +95533,10 @@ export interface operations { }; /** * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites)". + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.15/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -88873,7 +95572,7 @@ export interface operations { }; /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite). + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ "checks/set-suites-preferences": { @@ -88912,7 +95611,8 @@ export interface operations { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -88937,7 +95637,8 @@ export interface operations { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -88974,7 +95675,7 @@ export interface operations { }; /** * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -88997,16 +95698,13 @@ export interface operations { }; /** * List code scanning alerts for a repository - * @description Lists all open code scanning alerts for the default branch (usually `main` - * or `master`). You must use an access token with the `security_events` scope to use - * this endpoint with private repos, the `public_repo` scope also grants permission to read - * security events on public repos only. GitHub Apps must have the `security_events` read - * permission to use this endpoint. + * @description Lists code scanning alerts. * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert - * for the default branch or for the specified Git reference - * (if you used `ref` in the request). + * for the default branch (or for the specified Git reference if you used `ref` in the request). + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ "code-scanning/list-alerts-for-repo": { parameters: { @@ -89017,10 +95715,12 @@ export interface operations { per_page?: components["parameters"]["per-page"]; ref?: components["parameters"]["git-ref"]; direction?: components["parameters"]["direction"]; - /** @description The property by which to sort the results. . `number` is deprecated - we recommend that you use `created` instead. */ - sort?: "created" | "number" | "updated"; - /** @description Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ - state?: components["schemas"]["code-scanning-alert-state"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated"; + /** @description If specified, only code scanning alerts with this state will be returned. */ + state?: components["schemas"]["code-scanning-alert-state-query"]; + /** @description If specified, only code scanning alerts with this severity will be returned. */ + severity?: components["schemas"]["code-scanning-alert-severity"]; }; path: { owner: components["parameters"]["owner"]; @@ -89145,8 +95845,8 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -89196,7 +95896,7 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * @@ -89383,7 +96083,7 @@ export interface operations { }; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -89396,7 +96096,7 @@ export interface operations { * ``` * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.15/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -89415,6 +96115,8 @@ export interface operations { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -89495,13 +96197,41 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "code-security/get-configuration-for-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS * file. * * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * see "[About code owners](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ "repos/codeowners-errors": { parameters: { @@ -89597,17 +96327,17 @@ export interface operations { }; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Updating an existing collaborator's permission level** * @@ -89664,11 +96394,12 @@ export interface operations { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.15/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ "repos/remove-collaborator": { parameters: { @@ -89719,7 +96450,7 @@ export interface operations { * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -89753,7 +96484,7 @@ export interface operations { * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -89799,7 +96530,7 @@ export interface operations { * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -89834,12 +96565,12 @@ export interface operations { }; /** * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). + * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment). */ "reactions/list-for-commit-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ content?: | "+1" | "-1" @@ -89873,7 +96604,7 @@ export interface operations { }; /** * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ "reactions/create-for-commit-comment": { parameters: { @@ -89887,7 +96618,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the commit comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the commit comment. * @enum {string} */ content: @@ -89920,9 +96651,10 @@ export interface operations { }; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment). */ "reactions/delete-for-commit-comment": { parameters: { @@ -89952,6 +96684,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -89982,8 +96715,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - since?: components["parameters"]["since"]; - /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -90011,7 +96745,7 @@ export interface operations { }; /** * List branches for HEAD commit - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ @@ -90038,7 +96772,7 @@ export interface operations { * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -90073,9 +96807,9 @@ export interface operations { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -90099,7 +96833,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -90154,9 +96888,10 @@ export interface operations { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. @@ -90172,6 +96907,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -90221,9 +96957,10 @@ export interface operations { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. + * 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.15/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.15/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -90263,7 +97000,8 @@ export interface operations { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -90366,11 +97104,11 @@ export interface operations { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/enterprise-server@3.15/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.diff`**: Returns the diff of the commit. * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. @@ -90383,10 +97121,10 @@ export interface operations { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api)." * * **Signature verification object** * @@ -90398,6 +97136,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -90446,7 +97185,7 @@ export interface operations { * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -90460,9 +97199,9 @@ export interface operations { * * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.15/rest/git/trees#get-a-tree). * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.15/rest/git/trees#get-a-tree). * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. * - If the requested file's size is: * - 1 MB or smaller: All features of this endpoint are supported. @@ -90496,6 +97235,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -90504,7 +97244,8 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.15/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -90563,7 +97304,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -90577,7 +97325,8 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.15/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -90681,12 +97430,12 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** * @deprecated - * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; before?: components["parameters"]["pagination-before"]; @@ -90739,7 +97488,7 @@ export interface operations { }; /** * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -90872,7 +97621,7 @@ export interface operations { /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -90887,7 +97636,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ key_id?: string; @@ -91072,7 +97821,7 @@ export interface operations { * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) for every submitted context must be in a `success` + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.15/rest/commits/statuses) for every submitted context must be in a `success` * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do * not require any contexts or create any commit statuses, the deployment will always succeed. @@ -91129,7 +97878,7 @@ export interface operations { * @default true */ auto_merge?: boolean; - /** @description The [status](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ + /** @description The [status](https://docs.github.com/enterprise-server@3.15/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; payload?: OneOf< [ @@ -91209,7 +97958,7 @@ export interface operations { * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * * Mark the active deployment as inactive by adding any non-successful deployment status. * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.15/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.15/rest/deployments/statuses#create-a-deployment-status)." * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ @@ -91289,7 +98038,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -91354,7 +98106,7 @@ export interface operations { }; /** * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#repository_dispatch)." + * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#repository_dispatch)." * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * @@ -91374,7 +98126,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -91427,7 +98179,8 @@ export interface operations { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -91454,9 +98207,11 @@ export interface operations { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -91472,6 +98227,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?: | { @@ -91559,7 +98315,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -91595,7 +98351,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. * @@ -91621,7 +98377,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -91650,7 +98406,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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -91670,6 +98426,163 @@ export interface operations { }; }; }; + /** + * Get all deployment protection rules for an environment + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + "repos/get-all-deployment-protection-rules": { + parameters: { + path: { + environment_name: components["parameters"]["environment-name"]; + repo: components["parameters"]["repo"]; + owner: components["parameters"]["owner"]; + }; + }; + responses: { + /** @description List of deployment protection rules */ + 200: { + content: { + "application/json": { + /** + * @description The number of enabled custom deployment protection rules for this environment + * @example 10 + */ + total_count?: number; + custom_deployment_protection_rules?: components["schemas"]["deployment-protection-rule"][]; + }; + }; + }; + }; + }; + /** + * Create a custom deployment protection rule on an environment + * @description Enable a custom deployment protection rule for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "repos/create-deployment-protection-rule": { + parameters: { + path: { + environment_name: components["parameters"]["environment-name"]; + repo: components["parameters"]["repo"]; + owner: components["parameters"]["owner"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The ID of the custom app that will be enabled on the environment. */ + integration_id?: number; + }; + }; + }; + responses: { + /** @description The enabled custom deployment protection rule */ + 201: { + content: { + "application/json": components["schemas"]["deployment-protection-rule"]; + }; + }; + }; + }; + /** + * List custom deployment rule integrations available for an environment + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app)". + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + "repos/list-custom-deployment-rule-integrations": { + parameters: { + query?: { + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + }; + path: { + environment_name: components["parameters"]["environment-name"]; + repo: components["parameters"]["repo"]; + owner: components["parameters"]["owner"]; + }; + }; + responses: { + /** @description A list of custom deployment rule integrations available for this environment. */ + 200: { + content: { + "application/json": { + /** + * @description The total number of custom deployment protection rule integrations available for this environment. + * @example 35 + */ + total_count?: number; + available_custom_deployment_protection_rule_integrations?: components["schemas"]["custom-deployment-rule-app"][]; + }; + }; + }; + }; + }; + /** + * Get a custom deployment protection rule + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.15/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.15/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + */ + "repos/get-custom-deployment-protection-rule": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + environment_name: components["parameters"]["environment-name"]; + protection_rule_id: components["parameters"]["protection-rule-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["deployment-protection-rule"]; + }; + }; + }; + }; + /** + * Disable a custom protection rule for an environment + * @description Disables a custom deployment protection rule for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "repos/disable-deployment-protection-rule": { + parameters: { + path: { + environment_name: components["parameters"]["environment-name"]; + repo: components["parameters"]["repo"]; + owner: components["parameters"]["owner"]; + protection_rule_id: components["parameters"]["protection-rule-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List environment secrets * @description Lists all secrets available in an environment without revealing their @@ -91761,7 +98674,7 @@ export interface operations { /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/encrypting-secrets-for-the-rest-api)." * * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * @@ -91779,7 +98692,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#get-an-environment-public-key) endpoint. */ encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ key_id: string; @@ -91979,7 +98892,8 @@ export interface operations { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-repo-events": { parameters: { @@ -92032,9 +98946,11 @@ export interface operations { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ "repos/create-fork": { parameters: { @@ -92103,14 +99019,21 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw blob data. * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. @@ -92152,6 +99075,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -92185,7 +99109,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -92248,6 +99172,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -92292,7 +99217,8 @@ export interface operations { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -92321,7 +99247,8 @@ export interface operations { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ "git/get-ref": { parameters: { @@ -92437,7 +99364,7 @@ export interface operations { }; /** * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.15/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.15/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * * **Signature verification object** * @@ -92449,6 +99376,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -92531,6 +99459,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -92573,7 +99502,7 @@ export interface operations { * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.15/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.15/rest/git/refs#update-a-reference)." * * Returns an error if you try to delete a file that does not exist. */ @@ -92645,8 +99574,8 @@ export interface operations { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ "git/get-tree": { parameters: { @@ -92726,7 +99655,7 @@ export interface operations { insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; }; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for. * @default [ * "push" * ] @@ -92778,7 +99707,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -92812,7 +99746,7 @@ export interface operations { "application/json": { config?: components["schemas"]["webhook-config"]; /** - * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + * @description Determines what [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ * "push" * ] @@ -92906,7 +99840,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -92970,7 +99903,7 @@ export interface operations { }; /** * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) to be sent to the hook. */ "repos/ping-webhook": { parameters: { @@ -92992,7 +99925,8 @@ export interface operations { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ "repos/test-push-webhook": { parameters: { @@ -93014,7 +99948,7 @@ export interface operations { * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-repo-installation": { parameters: { @@ -93110,12 +100044,10 @@ export interface operations { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93165,12 +100097,12 @@ export interface operations { }; /** * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.9/articles/disabling-issues/), the API returns a `410 Gone` status. + * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.15/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93191,7 +100123,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: string | number | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -93236,7 +100168,7 @@ export interface operations { * * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93276,7 +100208,7 @@ export interface operations { * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93324,7 +100256,7 @@ export interface operations { * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93359,12 +100291,12 @@ export interface operations { }; /** * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). + * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment). */ "reactions/list-for-issue-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ content?: | "+1" | "-1" @@ -93398,7 +100330,7 @@ export interface operations { }; /** * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ "reactions/create-for-issue-comment": { parameters: { @@ -93412,7 +100344,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the issue comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the issue comment. * @enum {string} */ content: @@ -93445,9 +100377,10 @@ export interface operations { }; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#get-an-issue-comment). */ "reactions/delete-for-issue-comment": { parameters: { @@ -93519,19 +100452,17 @@ export interface operations { }; /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + * [transferred](https://docs.github.com/enterprise-server@3.15/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - * to the [`issues`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#issues) webhook. + * to the [`issues`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93561,9 +100492,9 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93585,7 +100516,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -93725,7 +100656,7 @@ export interface operations { * * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93763,12 +100694,12 @@ export interface operations { * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -93885,7 +100816,7 @@ export interface operations { "application/json": OneOf< [ { - /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#add-labels-to-an-issue)." */ + /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.15/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; }, { @@ -93927,7 +100858,7 @@ export interface operations { "application/json": OneOf< [ { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#set-labels-for-an-issue)." */ + /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.15/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; }, { @@ -94003,7 +100934,7 @@ export interface operations { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "issues/lock": { parameters: { @@ -94062,12 +100993,12 @@ export interface operations { }; /** * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). + * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). */ "reactions/list-for-issue": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ content?: | "+1" | "-1" @@ -94102,7 +101033,7 @@ export interface operations { }; /** * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ "reactions/create-for-issue": { parameters: { @@ -94116,7 +101047,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the issue. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the issue. * @enum {string} */ content: @@ -94149,9 +101080,10 @@ export interface operations { }; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). */ "reactions/delete-for-issue": { parameters: { @@ -94244,7 +101176,7 @@ export interface operations { /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.9/articles/permission-levels-for-a-user-account-repository/)." + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.15/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.15/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; @@ -94513,13 +101445,16 @@ export interface operations { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ "licenses/get-for-repo": { parameters: { + query?: { + ref?: components["parameters"]["git-ref"]; + }; path: { owner: components["parameters"]["owner"]; repo: components["parameters"]["repo"]; @@ -94837,7 +101772,7 @@ export interface operations { }; /** * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ "activity/mark-repo-notifications-as-read": { parameters: { @@ -94914,7 +101849,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.9/articles/using-a-custom-domain-with-github-pages/)." */ + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.15/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -95161,6 +102096,49 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + "repos/get-pages-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["pages-deployment-status"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + "repos/cancel-pages-deployment": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List pre-receive hooks for a repository * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. @@ -95329,6 +102307,61 @@ 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 read 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"]; + }; + }; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + "repos/create-or-update-custom-properties-values": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + responses: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { + content: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List pull requests * @description Lists pull requests in a specified repository. @@ -95336,10 +102369,10 @@ export interface operations { * 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-server@3.9/github/getting-started-with-github/githubs-products) + * Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95383,13 +102416,13 @@ export interface operations { }; /** * Create a pull request - * @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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95420,9 +102453,9 @@ export interface operations { base: string; /** @description The contents of the pull request. */ body?: string; - /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.9/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.15/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ maintainer_can_modify?: boolean; - /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/enterprise-server@3.9/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ + /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/enterprise-server@3.15/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ draft?: boolean; /** * Format: int64 @@ -95453,7 +102486,7 @@ export interface operations { * @description Lists review comments for all pull requests in a repository. By default, * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95491,7 +102524,7 @@ export interface operations { * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95540,7 +102573,7 @@ export interface operations { * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95574,12 +102607,12 @@ 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/rest/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.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ content?: | "+1" | "-1" @@ -95613,7 +102646,7 @@ export interface operations { }; /** * Create reaction for a pull request review comment - * @description Create a reaction 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). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ "reactions/create-for-pull-request-review-comment": { parameters: { @@ -95627,7 +102660,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the pull request review comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the pull request review comment. * @enum {string} */ content: @@ -95660,9 +102693,10 @@ export interface operations { }; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction 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). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.15/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/delete-for-pull-request-comment": { parameters: { @@ -95682,23 +102716,23 @@ export interface operations { }; /** * Get a pull request - * @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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.15/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95715,7 +102749,7 @@ export interface operations { }; }; responses: { - /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ + /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -95730,11 +102764,11 @@ export interface operations { }; /** * Update a pull request - * @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-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @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-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95763,7 +102797,7 @@ export interface operations { state?: "open" | "closed"; /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ base?: string; - /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.9/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ + /** @description Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.15/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ maintainer_can_modify?: boolean; }; }; @@ -95784,7 +102818,7 @@ export interface operations { * @description Lists all review comments for a specified pull request. By default, review comments * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95821,16 +102855,16 @@ export interface operations { }; /** * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment)." + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.15/rest/issues/comments#create-an-issue-comment)." * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95856,20 +102890,20 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** - * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/enterprise-server@3.9/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/enterprise-server@3.15/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ side?: "LEFT" | "RIGHT"; /** @description **Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ line?: number; - /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ + /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ start_line?: number; /** - * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.15/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ start_side?: "LEFT" | "RIGHT" | "side"; @@ -95905,10 +102939,10 @@ export interface operations { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95949,10 +102983,10 @@ export interface operations { /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits) + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-commits) * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -95987,10 +103021,10 @@ export interface operations { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96050,7 +103084,7 @@ export interface operations { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." */ "pulls/merge": { parameters: { @@ -96109,7 +103143,7 @@ export interface operations { }; /** * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ "pulls/list-requested-reviewers": { parameters: { @@ -96203,7 +103237,7 @@ export interface operations { * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96238,15 +103272,16 @@ export interface operations { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96269,7 +103304,7 @@ export interface operations { /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ body?: string; /** - * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. + * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; @@ -96308,7 +103343,7 @@ export interface operations { * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96338,7 +103373,7 @@ export interface operations { * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96376,7 +103411,7 @@ export interface operations { * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96407,7 +103442,7 @@ export interface operations { * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96444,11 +103479,10 @@ export interface operations { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.15/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96490,9 +103524,9 @@ export interface operations { }; /** * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.15/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -96536,6 +103570,7 @@ export interface operations { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -96548,7 +103583,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ + /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ expected_head_sha?: string; } | null; }; @@ -96571,7 +103606,7 @@ export interface operations { * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -96594,6 +103629,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -96602,7 +103638,7 @@ export interface operations { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). @@ -96633,7 +103669,7 @@ export interface operations { }; /** * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-tags). + * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ @@ -96665,7 +103701,7 @@ export interface operations { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." */ "repos/create-release": { parameters: { @@ -96725,7 +103761,13 @@ export interface operations { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ "repos/get-release-asset": { parameters: { @@ -96797,7 +103839,7 @@ export interface operations { }; /** * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ "repos/generate-release-notes": { parameters: { @@ -96879,9 +103921,8 @@ export interface operations { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ "repos/get-release": { parameters: { @@ -96892,7 +103933,7 @@ export interface operations { }; }; responses: { - /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ + /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { content: { "application/json": components["schemas"]["release"]; @@ -96995,8 +104036,8 @@ export interface operations { }; /** * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release) to upload a release asset. + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * @@ -97010,9 +104051,9 @@ export interface operations { * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets)" + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.15/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ "repos/upload-release-asset": { @@ -97047,12 +104088,12 @@ export interface operations { }; /** * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). + * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). */ "reactions/list-for-release": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -97078,7 +104119,7 @@ export interface operations { }; /** * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ "reactions/create-for-release": { parameters: { @@ -97092,7 +104133,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the release. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the release. * @enum {string} */ content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; @@ -97117,9 +104158,10 @@ export interface operations { }; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.15/rest/releases/releases#get-a-release). */ "reactions/delete-for-release": { parameters: { @@ -97175,6 +104217,258 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get rules for a branch + * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. + */ + "repos/get-branch-rules": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + branch: components["parameters"]["branch"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-rule-detailed"][]; + }; + }; + }; + }; + /** + * Get all repository rulesets + * @description Get all the rulesets for a repository. + */ + "repos/get-repo-rulesets": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + /** @description Include rulesets configured at higher levels that apply to this repository */ + includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Create a repository ruleset + * @description Create a ruleset for a repository. + */ + "repos/create-repo-ruleset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + /** @description Request body */ + requestBody: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name: string; + /** + * @description The target of the ruleset + * @default branch + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 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-server@3.15/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-server@3.15/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. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. + */ + "repos/get-repo-ruleset": { + parameters: { + query?: { + /** @description Include rulesets configured at higher levels that apply to this repository */ + includes_parents?: boolean; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Update a repository ruleset + * @description Update a ruleset for a repository. + */ + "repos/update-repo-ruleset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + /** @description Request body */ + requestBody?: { + content: { + "application/json": { + /** @description The name of the ruleset. */ + name?: string; + /** + * @description The target of the ruleset + * @enum {string} + */ + target?: "branch" | "tag" | "push"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["repository-rule"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["repository-ruleset"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Delete a repository ruleset + * @description Delete a ruleset for a repository. + */ + "repos/delete-repo-ruleset": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. @@ -97195,6 +104489,7 @@ export interface operations { per_page?: components["parameters"]["per-page"]; before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + validity?: components["parameters"]["secret-scanning-alert-validity"]; }; path: { owner: components["parameters"]["owner"]; @@ -97330,11 +104625,56 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "secret-scanning/create-push-protection-bypass": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + content: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + content: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -97593,7 +104933,7 @@ export interface operations { }; /** * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription) completely. + * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#delete-a-repository-subscription) completely. */ "activity/set-repo-subscription": { parameters: { @@ -97623,7 +104963,7 @@ export interface operations { }; /** * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription). + * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.15/rest/activity/watching#set-a-repository-subscription). */ "activity/delete-repo-subscription": { parameters: { @@ -97664,8 +105004,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -97688,8 +105032,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -97719,8 +105067,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -97745,7 +105097,9 @@ export interface operations { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -97831,7 +105185,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -97849,8 +105203,7 @@ export interface operations { }; /** * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/). - * You must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account. + * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.15/articles/about-repository-transfers/). */ "repos/transfer": { parameters: { @@ -97882,7 +105235,7 @@ export interface operations { }; /** * Check if vulnerability alerts are enabled for a repository - * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/check-vulnerability-alerts": { parameters: { @@ -97904,7 +105257,7 @@ export interface operations { }; /** * Enable vulnerability alerts - * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". + * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/enable-vulnerability-alerts": { parameters: { @@ -97924,7 +105277,7 @@ export interface operations { * Disable vulnerability alerts * @description Disables dependency alerts for a repository. * The authenticated user must have admin access to the repository. For more information, - * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". */ "repos/disable-vulnerability-alerts": { parameters: { @@ -97946,7 +105299,8 @@ export interface operations { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ "repos/download-zipball-archive": { parameters: { @@ -97969,7 +105323,7 @@ export interface operations { }; /** * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ @@ -98023,7 +105377,7 @@ export interface operations { * * Note: * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ "repos/list-public": { parameters: { @@ -98050,7 +105404,8 @@ export interface operations { }; /** * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM groups in an enterprise. * @@ -98085,7 +105440,8 @@ export interface operations { }; /** * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates a SCIM group for an enterprise. * @@ -98119,7 +105475,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM group. */ @@ -98150,7 +105507,8 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned group’s information. * @@ -98186,9 +105544,10 @@ export interface operations { }; /** * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { @@ -98212,7 +105571,8 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned group’s individual attributes. * @@ -98254,7 +105614,8 @@ export interface operations { }; /** * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Lists provisioned SCIM enterprise members. * @@ -98288,7 +105649,8 @@ export interface operations { }; /** * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Creates an external identity for a new SCIM enterprise user. * @@ -98324,7 +105686,8 @@ export interface operations { }; /** * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Gets information about a SCIM user. */ @@ -98352,13 +105715,15 @@ export interface operations { }; /** * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Replaces an existing provisioned user's information. * * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { @@ -98390,7 +105755,8 @@ export interface operations { }; /** * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ @@ -98416,25 +105782,28 @@ export interface operations { }; /** * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. + * @description > [!NOTE] + * > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. * * Update a provisioned user's individual attributes. * * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` + * > [!NOTE] + * > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * + * > [!WARNING] + * > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * > ``` + * > { + * > "Operations":[{ + * > "op":"replace", + * > "value":{ + * > "active":false + * > } + * > }] + * > } + * > ``` */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { @@ -98466,9 +105835,9 @@ export interface operations { }; /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * @@ -98488,9 +105857,9 @@ export interface operations { "search/code": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; @@ -98517,10 +105886,10 @@ export interface operations { }; /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - * metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * @@ -98529,9 +105898,9 @@ export interface operations { "search/commits": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -98554,10 +105923,10 @@ export interface operations { }; /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -98565,14 +105934,15 @@ export interface operations { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.15/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ "search/issues-and-pull-requests": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results) */ sort?: | "comments" | "reactions" @@ -98609,9 +105979,9 @@ export interface operations { }; /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -98624,9 +105994,9 @@ export interface operations { query: { /** @description The id of the repository. */ repository_id: number; - /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). */ + /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). */ q: string; - /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -98652,9 +106022,9 @@ export interface operations { }; /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -98665,9 +106035,9 @@ export interface operations { "search/repos": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.9/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-server@3.15/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -98692,9 +106062,9 @@ export interface operations { }; /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.9/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.15/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * @@ -98705,7 +106075,7 @@ export interface operations { "search/topics": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). */ q: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -98727,9 +106097,9 @@ export interface operations { }; /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * @@ -98737,14 +106107,14 @@ export interface operations { * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.15/graphql/reference/queries#search)." */ "search/users": { parameters: { query: { - /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ + /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ q: string; - /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ + /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; order?: components["parameters"]["order"]; per_page?: components["parameters"]["per-page"]; @@ -98767,284 +106137,11 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get the configuration status - * @description This endpoint allows you to check the status of the most recent configuration process: - * - * Note that you may need to wait several seconds after you start a process before you can check its status. - * - * The different statuses are: - * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | - */ - "enterprise-admin/get-configuration-status": { - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["configuration-status"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Start a configuration process - * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: - */ - "enterprise-admin/start-configuration-process": { - responses: { - /** @description Response */ - 202: { - content: never; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Get the maintenance status - * @description Check your installation's maintenance status: - */ - "enterprise-admin/get-maintenance-status": { - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["maintenance-status"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ - "enterprise-admin/enable-or-disable-maintenance-mode": { - requestBody: { - content: { - "application/x-www-form-urlencoded": { - /** - * @description A JSON string with the attributes `enabled` and `when`. - * - * The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. - * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ - maintenance: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["maintenance-status"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings). - * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. - */ - "enterprise-admin/get-settings": { - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["enterprise-settings"]; - }; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). - * - * **Notes:** - * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." - */ - "enterprise-admin/set-settings": { - requestBody: { - content: { - "application/x-www-form-urlencoded": { - /** @description A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). */ - settings: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** Get all authorized SSH keys */ - "enterprise-admin/get-all-authorized-ssh-keys": { - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["ssh-key"][]; - }; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Add an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ - "enterprise-admin/add-authorized-ssh-key": { - requestBody: { - content: { - "application/x-www-form-urlencoded": { - /** @description The public SSH key. */ - authorized_key: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["ssh-key"][]; - }; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Remove an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ - "enterprise-admin/remove-authorized-ssh-key": { - requestBody: { - content: { - "application/x-www-form-urlencoded": { - /** @description The public SSH key. */ - authorized_key: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["ssh-key"][]; - }; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Create a GitHub license - * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. - * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. - * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: - * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ - "enterprise-admin/create-enterprise-server-license": { - requestBody: { - content: { - "multipart/form-data": { - /** @description The content of your _.ghl_ license file. */ - license: string; - /** @description You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter. */ - password?: string; - /** @description An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). */ - settings?: string; - }; - }; - }; - responses: { - /** @description Response */ - 202: { - content: never; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; - /** - * Upgrade a license - * @description This API upgrades your license and also triggers the configuration process. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ - "enterprise-admin/upgrade-license": { - requestBody?: { - content: { - "multipart/form-data": { - /** @description The content of your new _.ghl_ license file. */ - license?: string; - }; - }; - }; - responses: { - /** @description Response */ - 202: { - content: never; - }; - /** @description Unauthorized */ - 401: { - content: never; - }; - }; - }; /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#get-a-team-by-name) endpoint. */ "teams/get-legacy": { parameters: { @@ -99065,7 +106162,8 @@ export interface operations { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -99089,11 +106187,13 @@ export interface operations { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -99119,7 +106219,16 @@ export interface operations { */ privacy?: "secret" | "closed"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: + | "notifications_enabled" + | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -99150,7 +106259,8 @@ export interface operations { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -99182,11 +106292,12 @@ export interface operations { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -99223,7 +106334,8 @@ export interface operations { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -99248,7 +106360,8 @@ export interface operations { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -99271,7 +106384,8 @@ export interface operations { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -99306,7 +106420,8 @@ export interface operations { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -99339,11 +106454,12 @@ export interface operations { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -99374,7 +106490,8 @@ export interface operations { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -99400,7 +106517,8 @@ export interface operations { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -99424,7 +106542,8 @@ export interface operations { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -99458,16 +106577,17 @@ export interface operations { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: | "+1" | "-1" @@ -99501,9 +106621,10 @@ export interface operations { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * @@ -99521,7 +106642,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion comment. * @enum {string} */ content: @@ -99548,16 +106669,17 @@ export interface operations { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ + /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: | "+1" | "-1" @@ -99590,9 +106712,10 @@ export interface operations { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * @@ -99609,7 +106732,7 @@ export interface operations { content: { "application/json": { /** - * @description The [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) to add to the team discussion. * @enum {string} */ content: @@ -99636,7 +106759,8 @@ export interface operations { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.15/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -99668,9 +106792,9 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * * To list members in a team, the team must be visible to the authenticated user. */ @@ -99695,17 +106819,18 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "teams/add-member-legacy": { parameters: { @@ -99733,15 +106858,16 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-member-legacy": { parameters: { @@ -99764,7 +106890,8 @@ export interface operations { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -99773,7 +106900,7 @@ export interface operations { * **Note:** * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#create-a-team). */ "teams/get-membership-for-user-legacy": { parameters: { @@ -99795,13 +106922,15 @@ export interface operations { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -99847,13 +106976,15 @@ export interface operations { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.15/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.15/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-membership-for-user-legacy": { parameters: { @@ -99876,7 +107007,8 @@ export interface operations { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -99906,7 +107038,8 @@ export interface operations { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -99933,7 +107066,8 @@ export interface operations { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -99948,7 +107082,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -99976,7 +107110,8 @@ export interface operations { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -99999,7 +107134,8 @@ export interface operations { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-repositories) endpoint. */ "teams/list-repos-legacy": { parameters: { @@ -100027,11 +107163,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -100061,11 +107199,12 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "teams/add-or-update-repo-permissions-legacy": { parameters: { @@ -100098,7 +107237,8 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -100120,7 +107260,8 @@ export interface operations { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-child-teams) endpoint. */ "teams/list-child-legacy": { parameters: { @@ -100403,7 +107544,7 @@ export interface operations { }; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ @@ -100422,6 +107563,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -100627,6 +107769,8 @@ export interface operations { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -100647,9 +107791,9 @@ export interface operations { }; /** * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. + * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -100666,18 +107810,20 @@ export interface operations { 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */ + 422: { + content: never; + }; }; }; /** * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. @@ -101080,6 +108226,9 @@ export interface operations { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -101107,7 +108256,7 @@ export interface operations { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-authenticated-user": { parameters: { @@ -101139,7 +108288,7 @@ export interface operations { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-authenticated-user": { parameters: { @@ -101161,7 +108310,7 @@ export interface operations { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-authenticated-user": { parameters: { @@ -101188,7 +108337,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-authenticated-user": { parameters: { @@ -101215,7 +108364,7 @@ export interface operations { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { @@ -101246,7 +108395,7 @@ export interface operations { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-authenticated-user": { parameters: { @@ -101271,7 +108420,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-authenticated-user": { parameters: { @@ -101299,7 +108448,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-authenticated-user": { parameters: { @@ -101356,7 +108505,7 @@ export interface operations { /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) * endpoint. * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. @@ -101523,7 +108672,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -101540,7 +108691,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -101786,7 +108939,7 @@ export interface operations { * @example Personal MacBook Air */ title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.9/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.15/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ key: string; }; }; @@ -101857,7 +109010,7 @@ export interface operations { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -101915,7 +109068,7 @@ export interface operations { }; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "activity/star-repo-for-authenticated-user": { parameters: { @@ -102014,11 +109167,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.15/rest/users/emails)". + */ + "users/get-by-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ "users/list": { parameters: { @@ -102045,9 +109224,9 @@ export interface operations { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.9/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.15/rest/users/emails)". */ "users/get-by-username": { parameters: { @@ -102092,7 +109271,10 @@ export interface operations { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-events-for-authenticated-user": { parameters: { @@ -102116,6 +109298,9 @@ export interface operations { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-org-events-for-authenticated-user": { parameters: { @@ -102137,7 +109322,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-user": { parameters: { query?: { @@ -102317,7 +109506,7 @@ export interface operations { * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/get-user-installation": { parameters: { @@ -102362,9 +109551,9 @@ export interface operations { }; /** * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership) for the specified user. + * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.15/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ "orgs/list-for-user": { parameters: { @@ -102392,7 +109581,7 @@ export interface operations { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-user": { parameters: { @@ -102429,7 +109618,7 @@ export interface operations { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-user": { parameters: { @@ -102452,9 +109641,9 @@ export interface operations { * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-user": { parameters: { @@ -102482,9 +109671,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-user": { parameters: { @@ -102512,7 +109701,7 @@ export interface operations { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { @@ -102538,7 +109727,7 @@ export interface operations { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-user": { parameters: { @@ -102562,9 +109751,9 @@ export interface operations { * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-user": { parameters: { @@ -102593,9 +109782,9 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.15/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-user": { parameters: { @@ -102647,7 +109836,11 @@ export interface operations { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-received-events-for-user": { parameters: { @@ -102668,7 +109861,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-received-public-events-for-user": { parameters: { query?: { @@ -102722,7 +109919,7 @@ export interface operations { }; /** * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "enterprise-admin/promote-user-to-be-site-administrator": { parameters: { @@ -102810,7 +110007,7 @@ export interface operations { * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ @@ -102868,11 +110065,11 @@ export interface operations { }; /** * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * * You can suspend any user account except your own. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." */ "enterprise-admin/suspend-user": { parameters: { @@ -102883,7 +110080,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Suspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ + /** @description The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Suspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ reason?: string; } | null; }; @@ -102897,7 +110094,7 @@ export interface operations { }; /** * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. + * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ "enterprise-admin/unsuspend-user": { parameters: { @@ -102908,7 +110105,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Unsuspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ + /** @description The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to "Unsuspended via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ is the person who performed the action. */ reason?: string; } | null; }; diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index b95af088a..eb3cc4ef8 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.6.0" + "openapi-version": "17.1.0" } } diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index 1b3f37d5b..9405a7c57 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -16,6 +16,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.6.0" + "openapi-version": "17.1.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index afa653c54..57634ccf1 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -138,8 +138,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -163,7 +161,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; @@ -171,17 +169,17 @@ export interface paths { "/applications/{client_id}/token": { /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -193,17 +191,14 @@ export interface paths { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; }; @@ -270,25 +265,104 @@ export interface paths { */ get: operations["emojis/get"]; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations": { /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/create-configuration-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/defaults": { + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + patch: operations["code-security/update-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-enterprise-configuration"]; }; "/enterprises/{enterprise}/dependabot/alerts": { /** @@ -319,7 +393,8 @@ export interface paths { "/events": { /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-public-events"]; }; @@ -338,7 +413,8 @@ export interface paths { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -352,7 +428,8 @@ export interface paths { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; }; @@ -511,10 +588,8 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -555,7 +630,7 @@ export interface paths { * Get a subscription plan for an account * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account"]; }; @@ -564,7 +639,7 @@ export interface paths { * List plans * @description Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans"]; }; @@ -573,7 +648,7 @@ export interface paths { * List accounts for a plan * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan"]; }; @@ -582,7 +657,7 @@ export interface paths { * Get a subscription plan for an account (stubbed) * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account-stubbed"]; }; @@ -591,7 +666,7 @@ export interface paths { * List plans (stubbed) * @description Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans-stubbed"]; }; @@ -600,7 +675,7 @@ export interface paths { * List accounts for a plan (stubbed) * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan-stubbed"]; }; @@ -613,12 +688,17 @@ export interface paths { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-repo-network"]; }; "/notifications": { @@ -685,10 +765,20 @@ export interface paths { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; }; + "/organizations/{org}/settings/billing/usage": { + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + }; "/orgs/{org}": { /** * Get an organization @@ -698,17 +788,6 @@ export interface paths { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -727,20 +806,13 @@ export interface paths { delete: operations["orgs/delete"]; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * @description > [!WARNING] + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -869,6 +941,109 @@ export interface paths { */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; }; + "/orgs/{org}/actions/runner-groups": { + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/get-self-hosted-runner-group-for-org"]; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-self-hosted-runners-in-group-for-org"]; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + }; "/orgs/{org}/actions/runners": { /** * List self-hosted runners for an organization @@ -1276,6 +1451,17 @@ export interface paths { */ delete: operations["actions/remove-selected-repo-from-org-variable"]; }; + "/orgs/{org}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["orgs/list-attestations"]; + }; "/orgs/{org}/blocks": { /** * List users blocked by an organization @@ -1311,6 +1497,117 @@ export interface paths { */ get: operations["code-scanning/list-alerts-for-org"]; }; + "/orgs/{org}/code-security/configurations": { + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-org"]; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/create-configuration"]; + }; + "/orgs/{org}/code-security/configurations/defaults": { + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations"]; + }; + "/orgs/{org}/code-security/configurations/detach": { + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configuration"]; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["code-security/update-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + }; "/orgs/{org}/codespaces": { /** * List codespaces for the organization @@ -1434,116 +1731,141 @@ export interface paths { "/orgs/{org}/copilot/billing": { /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. + * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; }; "/orgs/{org}/copilot/billing/seats": { /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; }; "/orgs/{org}/copilot/billing/selected_teams": { /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * Only organization owners can cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; }; "/orgs/{org}/copilot/billing/selected_users": { /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Only organization owners can cancel Copilot seats for their organization members. * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * The response contains the total number of seats set to "pending cancellation". * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; }; + "/orgs/{org}/copilot/metrics": { + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + }; "/orgs/{org}/copilot/usage": { /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. + * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-org"]; }; @@ -1722,7 +2044,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-org-events"]; }; "/orgs/{org}/failed_invitations": { @@ -1735,7 +2061,9 @@ export interface paths { "/orgs/{org}/hooks": { /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -1766,7 +2094,9 @@ export interface paths { get: operations["orgs/get-webhook"]; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -1858,6 +2188,69 @@ export interface paths { */ post: operations["orgs/ping-webhook"]; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/subject-stats": { + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats": { + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/time-stats": { + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + }; "/orgs/{org}/installation": { /** * Get an organization installation for the authenticated app @@ -1899,14 +2292,17 @@ export interface paths { "/orgs/{org}/invitations": { /** * List pending organization invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * @description The return hash contains a `role` field which refers to the Organization + * Invitation role and will be one of the following values: `direct_member`, `admin`, + * `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub + * member, the `login` field in the return hash will be `null`. */ get: operations["orgs/list-pending-invitations"]; /** * Create an organization invitation * @description Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["orgs/create-invitation"]; @@ -1932,10 +2328,8 @@ export interface paths { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -1995,13 +2389,17 @@ export interface paths { "/orgs/{org}/members/{username}/copilot": { /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can view Copilot seat assignment details for members of their organization. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; }; @@ -2021,7 +2419,7 @@ export interface paths { * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; /** @@ -2086,26 +2484,10 @@ export interface paths { */ get: operations["migrations/list-repos-for-org"]; }; - "/orgs/{org}/organization-fine-grained-permissions": { - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - get: operations["orgs/list-organization-fine-grained-permissions"]; - }; "/orgs/{org}/organization-roles": { /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2115,23 +2497,11 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-roles"]; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - post: operations["orgs/create-custom-organization-role"]; }; "/orgs/{org}/organization-roles/teams/{team_slug}": { /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2142,7 +2512,7 @@ export interface paths { "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2151,7 +2521,7 @@ export interface paths { put: operations["orgs/assign-team-to-org-role"]; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2162,7 +2532,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}": { /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2173,7 +2543,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}/{role_id}": { /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2182,7 +2552,7 @@ export interface paths { put: operations["orgs/assign-user-to-org-role"]; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2193,7 +2563,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}": { /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2203,36 +2573,11 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/get-org-role"]; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - delete: operations["orgs/delete-custom-organization-role"]; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - patch: operations["orgs/patch-custom-organization-role"]; }; "/orgs/{org}/organization-roles/{role_id}/teams": { /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -2243,7 +2588,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}/users": { /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -2275,7 +2620,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; }; @@ -2284,7 +2629,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; /** @@ -2293,7 +2638,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; }; @@ -2308,7 +2653,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; }; @@ -2317,7 +2662,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; }; @@ -2326,7 +2671,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; /** @@ -2335,7 +2680,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; }; @@ -2350,7 +2695,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; }; @@ -2422,6 +2767,73 @@ export interface paths { */ get: operations["orgs/list-pat-grant-repositories"]; }; + "/orgs/{org}/private-registries": { + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/list-org-private-registries"]; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["private-registries/create-org-private-registry"]; + }; + "/orgs/{org}/private-registries/public-key": { + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + }; + "/orgs/{org}/private-registries/{secret_name}": { + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["private-registries/update-org-private-registry"]; + }; "/orgs/{org}/projects": { /** * List organization projects @@ -2530,7 +2942,8 @@ export interface paths { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; /** @@ -2573,6 +2986,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -2611,31 +3027,25 @@ export interface paths { "/orgs/{org}/security-managers": { /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; }; "/orgs/{org}/security-managers/teams/{team_slug}": { /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; }; @@ -2672,25 +3082,45 @@ export interface paths { */ get: operations["billing/get-shared-storage-billing-org"]; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-team"]; }; @@ -2713,7 +3143,8 @@ export interface paths { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; /** @@ -2722,14 +3153,16 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; }; @@ -2738,7 +3171,8 @@ export interface paths { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2747,9 +3181,10 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2760,7 +3195,8 @@ export interface paths { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2769,7 +3205,8 @@ export interface paths { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2778,7 +3215,8 @@ export interface paths { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2789,7 +3227,8 @@ export interface paths { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2798,9 +3237,10 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2811,7 +3251,8 @@ export interface paths { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2820,7 +3261,8 @@ export interface paths { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2829,7 +3271,8 @@ export interface paths { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2840,7 +3283,8 @@ export interface paths { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2851,7 +3295,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2860,7 +3305,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -2873,7 +3319,8 @@ export interface paths { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -2884,7 +3331,8 @@ export interface paths { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -2893,7 +3341,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -2906,7 +3355,8 @@ export interface paths { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ get: operations["teams/list-pending-invitations-in-org"]; }; @@ -2926,10 +3376,11 @@ export interface paths { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ @@ -2940,13 +3391,15 @@ export interface paths { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; /** @@ -2955,9 +3408,11 @@ export interface paths { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; }; @@ -2966,7 +3421,8 @@ export interface paths { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; }; @@ -2975,21 +3431,24 @@ export interface paths { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; }; @@ -2998,7 +3457,8 @@ export interface paths { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; }; @@ -3007,20 +3467,22 @@ export interface paths { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -3029,7 +3491,8 @@ export interface paths { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; }; @@ -3038,18 +3501,23 @@ export interface paths { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; }; "/orgs/{org}/{security_product}/{enablement}": { /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -3156,7 +3624,8 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -3167,9 +3636,10 @@ export interface paths { * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; }; @@ -3178,7 +3648,8 @@ export interface paths { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; /** @@ -3566,7 +4037,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; }; @@ -3668,8 +4139,8 @@ export interface paths { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -3928,6 +4399,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; }; @@ -3972,6 +4445,28 @@ export interface paths { */ get: operations["issues/check-user-can-be-assigned"]; }; + "/repos/{owner}/{repo}/attestations": { + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["repos/create-attestation"]; + }; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["repos/list-attestations"]; + }; "/repos/{owner}/{repo}/autolinks": { /** * Get all autolinks of a repository @@ -4039,9 +4534,11 @@ export interface paths { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; /** @@ -4088,7 +4585,8 @@ export interface paths { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; }; @@ -4099,7 +4597,8 @@ export interface paths { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; /** @@ -4165,7 +4664,8 @@ export interface paths { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; /** @@ -4283,7 +4783,8 @@ export interface paths { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -4307,7 +4808,8 @@ export interface paths { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4316,7 +4818,8 @@ export interface paths { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4347,7 +4850,8 @@ export interface paths { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -4366,7 +4870,8 @@ export interface paths { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4377,7 +4882,8 @@ export interface paths { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -4423,6 +4929,37 @@ export interface paths { */ patch: operations["code-scanning/update-alert"]; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-autofix"]; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/create-autofix"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/commit-autofix"]; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { /** * List instances of a code scanning alert @@ -4446,8 +4983,8 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -4549,7 +5086,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; }; @@ -4560,13 +5097,52 @@ export interface paths { * * By default this endpoint returns JSON metadata about the CodeQL database. To * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure + * to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + delete: operations["code-scanning/delete-codeql-database"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["code-scanning/create-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-variant-analysis-repo-task"]; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { /** @@ -4619,6 +5195,8 @@ export interface paths { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -4630,6 +5208,17 @@ export interface paths { */ get: operations["code-scanning/get-sarif"]; }; + "/repos/{owner}/{repo}/code-security-configuration": { + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + }; "/repos/{owner}/{repo}/codeowners/errors": { /** * List CODEOWNERS errors @@ -4710,8 +5299,6 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; @@ -4768,7 +5355,7 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -4809,7 +5396,8 @@ export interface paths { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -4887,7 +5475,8 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ @@ -4906,6 +5495,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -4953,7 +5543,7 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -4978,7 +5568,8 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -4996,6 +5587,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5022,7 +5614,8 @@ export interface paths { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. * @@ -5035,7 +5628,8 @@ export interface paths { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -5101,7 +5695,7 @@ export interface paths { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)." @@ -5116,6 +5710,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5171,7 +5766,8 @@ export interface paths { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -5186,7 +5782,8 @@ export interface paths { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; }; @@ -5415,7 +6012,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -5426,9 +6024,11 @@ export interface paths { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -5507,7 +6107,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -5643,7 +6245,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-repo-events"]; }; @@ -5654,9 +6257,11 @@ export interface paths { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; }; @@ -5693,6 +6298,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5731,6 +6337,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5759,7 +6366,8 @@ export interface paths { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -5770,7 +6378,8 @@ export interface paths { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; }; @@ -5808,6 +6417,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5842,6 +6452,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5881,8 +6492,8 @@ export interface paths { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; }; @@ -5905,7 +6516,12 @@ export interface paths { * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -5962,7 +6578,8 @@ export interface paths { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; }; @@ -5972,7 +6589,8 @@ export interface paths { * @deprecated * @description View the progress of an import. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -6015,7 +6633,8 @@ export interface paths { * 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6023,7 +6642,8 @@ export interface paths { * @deprecated * @description Stop an import for a repository. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6036,7 +6656,8 @@ 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6048,7 +6669,8 @@ export interface paths { * * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6059,7 +6681,8 @@ export interface paths { * @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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6069,7 +6692,8 @@ export interface paths { * @deprecated * @description List files larger than 100MB found during the import * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6083,7 +6707,8 @@ export interface paths { * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6131,10 +6756,8 @@ export interface paths { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6148,7 +6771,7 @@ export interface paths { * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6222,7 +6845,8 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ @@ -6252,10 +6876,8 @@ export interface paths { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6267,7 +6889,7 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6322,7 +6944,7 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6399,12 +7021,65 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-sub-issues"]; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { /** * List timeline events for an issue @@ -6714,7 +7389,7 @@ export interface paths { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6786,7 +7461,8 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -6809,7 +7485,7 @@ export interface paths { * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6864,9 +7540,9 @@ export interface paths { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6883,7 +7559,7 @@ export interface paths { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -6916,8 +7592,8 @@ export interface paths { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -6937,7 +7613,7 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; }; @@ -6975,11 +7651,12 @@ export interface paths { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -7049,9 +7726,8 @@ export interface paths { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -7080,6 +7756,7 @@ export interface paths { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -7119,14 +7796,20 @@ export interface paths { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; /** Delete a release asset */ @@ -7165,9 +7848,8 @@ export interface paths { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; /** @@ -7223,7 +7905,8 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ @@ -7271,6 +7954,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -7326,6 +8012,26 @@ export interface paths { */ get: operations["secret-scanning/list-locations-for-alert"]; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + get: operations["secret-scanning/get-scan-history"]; + }; "/repos/{owner}/{repo}/security-advisories": { /** * List repository security advisories @@ -7396,7 +8102,8 @@ export interface paths { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ post: operations["security-advisories/create-fork"]; }; @@ -7414,11 +8121,10 @@ export interface paths { "/repos/{owner}/{repo}/stats/code_frequency": { /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; }; @@ -7440,7 +8146,8 @@ export interface paths { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; }; @@ -7507,23 +8214,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -7534,7 +8253,9 @@ export interface paths { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -7616,7 +8337,8 @@ export interface paths { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ get: operations["repos/download-zipball-archive"]; }; @@ -7694,7 +8416,8 @@ export interface paths { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; }; @@ -7764,13 +8487,15 @@ export interface paths { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -7780,11 +8505,13 @@ export interface paths { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -7792,7 +8519,8 @@ export interface paths { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -7802,11 +8530,12 @@ export interface paths { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7816,7 +8545,8 @@ export interface paths { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -7826,7 +8556,8 @@ export interface paths { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -7836,7 +8567,8 @@ export interface paths { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -7848,7 +8580,8 @@ export interface paths { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -7858,11 +8591,12 @@ export interface paths { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -7872,7 +8606,8 @@ export interface paths { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -7882,7 +8617,8 @@ export interface paths { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -7892,7 +8628,8 @@ export interface paths { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -7904,7 +8641,8 @@ export interface paths { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -7914,7 +8652,8 @@ export interface paths { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -7928,7 +8667,8 @@ export interface paths { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -7938,7 +8678,8 @@ export interface paths { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -7952,7 +8693,8 @@ export interface paths { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -7962,7 +8704,8 @@ export interface paths { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -7972,7 +8715,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -7982,7 +8725,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -7990,7 +8733,8 @@ export interface paths { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -7998,7 +8742,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -8006,7 +8750,8 @@ export interface paths { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; }; @@ -8014,7 +8759,8 @@ export interface paths { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -8029,13 +8775,15 @@ export interface paths { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -8045,13 +8793,15 @@ export interface paths { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; }; @@ -8059,7 +8809,8 @@ export interface paths { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -8069,7 +8820,8 @@ export interface paths { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -8077,7 +8829,8 @@ export interface paths { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -8085,7 +8838,8 @@ export interface paths { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -8095,7 +8849,8 @@ export interface paths { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; }; @@ -8103,17 +8858,20 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -8123,7 +8881,8 @@ export interface paths { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -8133,7 +8892,8 @@ export interface paths { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; }; @@ -8493,11 +9253,15 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -8523,10 +9287,8 @@ export interface paths { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -8680,6 +9442,9 @@ export interface paths { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -8688,7 +9453,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; }; @@ -8697,14 +9462,14 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; /** * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; }; @@ -8717,7 +9482,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; }; @@ -8726,7 +9491,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; }; @@ -8735,7 +9500,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; /** @@ -8744,7 +9509,7 @@ export interface paths { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; }; @@ -8757,7 +9522,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; }; @@ -8908,6 +9673,17 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users @@ -8928,6 +9704,17 @@ export interface paths { */ get: operations["users/get-by-username"]; }; + "/users/{username}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["users/list-attestations"]; + }; "/users/{username}/docker/conflicts": { /** * Get list of conflicting packages during Docker migration for user @@ -8940,7 +9727,10 @@ export interface paths { "/users/{username}/events": { /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-events-for-authenticated-user"]; }; @@ -8948,11 +9738,18 @@ export interface paths { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-public-events-for-user"]; }; "/users/{username}/followers": { @@ -9028,7 +9825,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; }; @@ -9037,7 +9834,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; /** @@ -9046,7 +9843,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; }; @@ -9061,7 +9858,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; }; @@ -9070,7 +9867,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; }; @@ -9079,7 +9876,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; /** @@ -9088,7 +9885,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; }; @@ -9103,7 +9900,7 @@ export interface paths { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; }; @@ -9117,12 +9914,20 @@ export interface paths { "/users/{username}/received_events": { /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ get: operations["activity/list-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ get: operations["activity/list-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -9257,6 +10062,22 @@ export interface paths { */ get: operations["repos/compare-commits"]; }; + "/orgs/{org}/organization-fine-grained-permissions": { + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + }; } export type webhooks = Record; @@ -9367,6 +10188,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ vulnerable_functions: readonly string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -9376,7 +10211,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9435,6 +10273,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -9534,6 +10374,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -9542,6 +10383,10 @@ export interface components { name: string; }[] | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; /** @description The users who contributed to the advisory. */ credits: | readonly { @@ -9578,7 +10423,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9637,6 +10485,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * GitHub app @@ -9655,6 +10505,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -9711,8 +10563,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -9808,6 +10658,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -9898,6 +10754,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -10143,7 +11005,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -10178,7 +11040,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -10337,6 +11199,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -10628,7 +11491,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10741,6 +11604,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -11212,184 +12076,156 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The type of the code security configuration. + * @enum {string} */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: - | { - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - [key: string]: unknown; - }[] - | null; - }; - /** @description The security alert number. */ - readonly "alert-number": number; - /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { - /** @description The package's language or package management ecosystem. */ - readonly ecosystem: string; - /** @description The unique package name within its ecosystem. */ - readonly name: string; - }; - /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; /** - * @description The severity of the vulnerability. + * @description The enablement status of GitHub Advanced Security * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ - readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ - readonly first_patched_version: { - /** @description The package version that patches this vulnerability. */ - readonly identifier: string; - } | null; - }; - /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { - /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ - readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ - readonly cve_id: string | null; - /** @description A short, plain text summary of the advisory. */ - readonly summary: string; - /** @description A long-form Markdown-supported description of the advisory. */ - readonly description: string; - /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + advanced_security?: "enabled" | "disabled"; /** - * @description The severity of the advisory. + * @description The enablement status of Dependency Graph * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ - readonly cvss: { - /** @description The overall CVSS score of the advisory. */ - readonly score: number; - /** @description The full CVSS vector string for the advisory. */ - readonly vector_string: string | null; + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; }; - /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { - /** @description The unique CWE ID. */ - readonly cwe_id: string; - /** @description The short, plain text name of the CWE. */ - readonly name: string; - }[]; - /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { - /** - * @description The type of advisory identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The value of the advisory identifer. */ - readonly value: string; - }[]; - /** @description Links to additional advisory information. */ - readonly references: readonly { + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { /** - * Format: uri - * @description The URL of the reference. + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} */ - readonly url: string; - }[]; + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; /** - * Format: date-time - * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning + * @enum {string} */ - readonly published_at: string; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning push protection + * @enum {string} */ - readonly updated_at: string; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning delegated bypass + * @enum {string} */ - readonly withdrawn_at: string | null; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; }; - /** - * Format: uri - * @description The REST API URL of the alert resource. - */ - readonly "alert-url": string; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly "alert-html-url": string; - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly "alert-created-at": string; - /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly "alert-updated-at": string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly "alert-dismissed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly "alert-fixed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly "alert-auto-dismissed-at": string | null; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** * Simple Repository * @description A GitHub repository. */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -11625,6 +12461,149 @@ export interface components { */ hooks_url: string; }; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; + /** @description The security alert number. */ + readonly "alert-number": number; + /** @description Details for the vulnerable package. */ + readonly "dependabot-alert-package": { + /** @description The package's language or package management ecosystem. */ + readonly ecosystem: string; + /** @description The unique package name within its ecosystem. */ + readonly name: string; + }; + /** @description Details pertaining to one vulnerable version range for the advisory. */ + readonly "dependabot-alert-security-vulnerability": { + readonly package: components["schemas"]["dependabot-alert-package"]; + /** + * @description The severity of the vulnerability. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ + readonly vulnerable_version_range: string; + /** @description Details pertaining to the package version that patches this vulnerability. */ + readonly first_patched_version: { + /** @description The package version that patches this vulnerability. */ + readonly identifier: string; + } | null; + }; + /** @description Details for the GitHub Security Advisory. */ + readonly "dependabot-alert-security-advisory": { + /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ + readonly ghsa_id: string; + /** @description The unique CVE ID assigned to the advisory. */ + readonly cve_id: string | null; + /** @description A short, plain text summary of the advisory. */ + readonly summary: string; + /** @description A long-form Markdown-supported description of the advisory. */ + readonly description: string; + /** @description Vulnerable version range information for the advisory. */ + readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ + readonly cvss: { + /** @description The overall CVSS score of the advisory. */ + readonly score: number; + /** @description The full CVSS vector string for the advisory. */ + readonly vector_string: string | null; + }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; + /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ + readonly cwes: readonly { + /** @description The unique CWE ID. */ + readonly cwe_id: string; + /** @description The short, plain text name of the CWE. */ + readonly name: string; + }[]; + /** @description Values that identify this advisory among security information sources. */ + readonly identifiers: readonly { + /** + * @description The type of advisory identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The value of the advisory identifer. */ + readonly value: string; + }[]; + /** @description Links to additional advisory information. */ + readonly references: readonly { + /** + * Format: uri + * @description The URL of the reference. + */ + readonly url: string; + }[]; + /** + * Format: date-time + * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly withdrawn_at: string | null; + }; + /** + * Format: uri + * @description The REST API URL of the alert resource. + */ + readonly "alert-url": string; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly "alert-html-url": string; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "alert-created-at": string; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "alert-updated-at": string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "alert-dismissed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "alert-fixed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -11712,7 +12691,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -11726,6 +12705,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -11733,6 +12722,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** * Actor @@ -11834,6 +12827,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -11890,8 +12885,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -11928,6 +12921,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -12035,6 +13034,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -12194,6 +13194,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -12203,6 +13208,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -12217,7 +13223,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -12248,6 +13256,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -12265,8 +13275,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -12350,6 +13358,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -12375,6 +13384,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -12382,6 +13396,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -12717,18 +13732,49 @@ export interface components { * ] */ actions?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + actions_macos?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + codespaces?: string[]; /** * @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -12752,13 +13798,24 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_ai_detection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -13054,6 +14111,32 @@ export interface components { /** @example A great organization */ description: string | null; }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -13139,7 +14222,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -13177,47 +14265,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * This field is only visible to organization owners or members of a team with the security manager role. * @example false @@ -13242,6 +14343,11 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + deploy_keys_enabled_for_repositories?: boolean; }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -13310,7 +14416,8 @@ export interface components { /** * @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * - * **Note**: The `patterns_allowed` setting only applies to public repositories. + * > [!NOTE] + * > The `patterns_allowed` setting only applies to public repositories. */ patterns_allowed?: string[]; }; @@ -13329,6 +14436,31 @@ export interface components { default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + workflow_restrictions_read_only?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -13542,18 +14674,18 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -13561,8 +14693,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -13575,6 +14705,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -13695,7 +14833,10 @@ export interface components { * @description A codespace. */ codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -13936,8 +15077,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -13970,8 +15111,52 @@ export interface components { | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -14068,99 +15253,43 @@ export interface components { parent: components["schemas"]["nullable-team-simple"]; }; /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories + * Enterprise Team + * @description Group of enterprise owners and/or members */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; + "enterprise-team": { + /** Format: int64 */ id: number; - node_id: string; - /** Format: uri */ - repos_url: string; + name: string; + slug: string; /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; /** * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com + * @example https://github.com/enterprises/dc/teams/justice-league */ - blog?: string; - /** Format: uri */ html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; + members_url: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & ( - | components["schemas"]["simple-user"] + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: | components["schemas"]["team"] - | components["schemas"]["organization"] - ); - /** @description The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually. */ - assigning_team?: components["schemas"]["team"] | null; + | components["schemas"]["enterprise-team"] + | null; /** * Format: date * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. @@ -14180,9 +15309,202 @@ export interface components { created_at: string; /** * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": { + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + [key: string]: unknown; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": { + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": { + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": { + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: + | { + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users?: number; + [key: string]: unknown; + }[] + | null; }; /** * Dependabot Secret for an Organization @@ -14230,7 +15552,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14488,6 +15813,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { + /** Format: int64 */ id: number; login: string | null; email: string | null; @@ -14559,6 +15885,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method?: string; + /** @description The API path's route template */ + api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type?: string; + subject_name?: string; + /** Format: int64 */ + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp?: string; + /** Format: int64 */ + total_request_count?: number; + /** Format: int64 */ + rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; + /** Format: int64 */ + actor_id?: number; + /** Format: int64 */ + integration_id?: number | null; + /** Format: int64 */ + oauth_application_id?: number | null; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -14639,7 +16046,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -14677,25 +16087,30 @@ export interface components { /** @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"`. */ exclude?: string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - "organization-fine-grained-permission": { - name: string; - description: string; - }; /** * Organization Role * @description Organization roles */ "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ id: number; /** @description The name of the role. */ name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -14710,6 +16125,186 @@ export interface components { */ updated_at: string; }; + /** + * A Role Assignment for a Team + * @description The Relationship a Team has with a role. + */ + "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + }; + /** + * A Role Assignment for a User + * @description The Relationship a User has with a role. + */ + "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** @example 1 */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + }; /** * Package Version * @description A version of a software package @@ -14803,6 +16398,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14815,7 +16414,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -14839,6 +16438,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14846,6 +16449,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -14915,15 +16580,26 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select * @enum {string} */ - value_type: "string" | "single_select"; + value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -14942,6 +16618,29 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | string[] | null; + /** @description Short description of the property */ + description?: string | null; + /** + * @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. + */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -14972,6 +16671,7 @@ export interface components { */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -15263,7 +16963,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -15347,7 +17047,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -15666,7 +17369,6 @@ export interface components { actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: @@ -15676,11 +17378,11 @@ export interface components { | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ - bypass_mode: "always" | "pull_request"; + bypass_mode?: "always" | "pull_request"; }; /** * Repository ruleset conditions for ref names @@ -15727,6 +17429,11 @@ export interface components { name: string; /** @description The values to match for the repository property */ property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -15742,7 +17449,10 @@ export interface components { }; /** * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & @@ -15787,6 +17497,36 @@ export interface components { /** @enum {string} */ type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -15807,6 +17547,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -15815,6 +17567,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -15845,6 +17599,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -15996,6 +17752,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -16023,6 +17781,18 @@ export interface components { /** @description The name of a code scanning tool */ tool: string; }; + /** + * code_scanning + * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. + */ + "repository-rule-code-scanning": { + /** @enum {string} */ + type: "code_scanning"; + parameters?: { + /** @description Tools that must provide code scanning results for this rule to pass. */ + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; + }; + }; /** * Repository Rule * @description A repository rule. @@ -16032,6 +17802,7 @@ export interface components { | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] + | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] @@ -16074,7 +17845,8 @@ export interface components { max_file_size: number; }; } - | components["schemas"]["repository-rule-workflows"]; + | components["schemas"]["repository-rule-workflows"] + | components["schemas"]["repository-rule-code-scanning"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -16086,16 +17858,14 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -16116,7 +17886,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: | ( @@ -16165,7 +17935,7 @@ export interface components { * @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"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -16199,10 +17969,10 @@ export interface components { */ 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} + * @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`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -16225,8 +17995,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -16335,6 +18105,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -16362,69 +18133,6 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ private_fork: components["schemas"]["simple-repository"] | null; }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; "actions-billing-usage": { /** @description The sum of the free and paid GitHub Actions minutes used. */ total_minutes_used: number; @@ -17215,6 +18923,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -17331,6 +19040,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -17647,6 +19357,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -17654,6 +19365,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17663,6 +19375,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17934,6 +19647,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -17985,6 +19699,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -18320,6 +20035,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -18337,6 +20053,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -18392,8 +20109,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -18492,6 +20212,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -18587,8 +20308,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -18806,6 +20533,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -18963,7 +20691,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -19068,7 +20799,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -19099,6 +20830,40 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": + | "pending" + | "error" + | "success" + | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -19193,6 +20958,150 @@ export interface components { /** @description The commit SHA of the repository at the time the CodeQL database was created. */ commit_oid?: string | null; }; + /** + * @description The language targeted by the CodeQL query + * @enum {string} + */ + "code-scanning-variant-analysis-language": + | "cpp" + | "csharp" + | "go" + | "java" + | "javascript" + | "python" + | "ruby" + | "swift"; + /** + * Repository Identifier + * @description Repository Identifier + */ + "code-scanning-variant-analysis-repository": { + /** + * @description A unique identifier of the repository. + * @example 1296269 + */ + id: number; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + /** @description Whether the repository is private. */ + private: boolean; + /** @example 80 */ + stargazers_count: number; + /** + * Format: date-time + * @example 2011-01-26T19:14:43Z + */ + updated_at: string | null; + }; + /** + * @description The new status of the CodeQL variant analysis repository task. + * @enum {string} + */ + "code-scanning-variant-analysis-status": + | "pending" + | "in_progress" + | "succeeded" + | "failed" + | "canceled" + | "timed_out"; + "code-scanning-variant-analysis-skipped-repo-group": { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. */ + repositories: components["schemas"]["code-scanning-variant-analysis-repository"][]; + }; + /** + * Variant Analysis + * @description A run of a CodeQL query against one or more repositories. + */ + "code-scanning-variant-analysis": { + /** @description The ID of the variant analysis. */ + id: number; + controller_repo: components["schemas"]["simple-repository"]; + actor: components["schemas"]["simple-user"]; + query_language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description The download url for the query pack. */ + query_pack_url: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + */ + completed_at?: string | null; + /** @enum {string} */ + status: "in_progress" | "succeeded" | "failed" | "cancelled"; + /** @description The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. */ + actions_workflow_run_id?: number; + /** + * @description The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. + * @enum {string} + */ + failure_reason?: + | "no_repos_queried" + | "actions_workflow_run_failed" + | "internal_error"; + scanned_repositories?: { + repository: components["schemas"]["code-scanning-variant-analysis-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + }[]; + /** @description Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. */ + skipped_repositories?: { + access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + not_found_repos: { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of full repository names that were skipped. This list may not include all repositories that were skipped. */ + repository_full_names: string[]; + }; + no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + }; + }; + "code-scanning-variant-analysis-repo-task": { + repository: components["schemas"]["simple-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + /** @description The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. */ + database_commit_sha?: string; + /** @description The source location prefix to use. This is only available for successful analyses. */ + source_location_prefix?: string; + /** @description The URL of the artifact. This is only available for successful analyses. */ + artifact_url?: string; + }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { /** @@ -19202,6 +21111,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -19213,6 +21123,16 @@ export interface components { | "typescript" | "swift" )[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -19237,6 +21157,16 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -19244,6 +21174,7 @@ export interface components { query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -19294,6 +21225,23 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ errors?: readonly string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -19415,7 +21363,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -19483,6 +21434,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; }; /** * Repository Invitation @@ -19490,6 +21443,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -19526,7 +21480,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -19594,6 +21551,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -19674,7 +21633,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -19964,6 +21926,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -19977,7 +21940,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -20178,6 +22140,23 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; + }; + }; + }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; }; }; }; @@ -20215,6 +22194,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -20327,6 +22307,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -20346,11 +22331,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -20361,7 +22344,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -20398,6 +22381,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -20416,6 +22404,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -20543,7 +22542,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -20575,7 +22577,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -20634,6 +22636,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -20911,6 +22914,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -21293,6 +23297,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -21710,6 +23715,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -21726,14 +23732,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -21879,6 +23891,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -21944,11 +23957,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -21969,12 +23984,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -22196,6 +24211,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -22567,7 +24583,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -22676,359 +24695,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -23096,6 +24772,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -23149,9 +24826,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -23362,6 +25045,8 @@ export interface components { components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-merge-queue"] & + components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & @@ -23383,6 +25068,8 @@ export interface components { | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; @@ -23409,7 +25096,7 @@ export interface components { secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -23422,11 +25109,25 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -23555,7 +25256,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -23564,7 +25265,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -23630,6 +25331,52 @@ export interface components { | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": + | "false_positive" + | "used_in_tests" + | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -24076,6 +25823,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -24302,6 +26055,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -24347,6 +26101,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -24355,8 +26110,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -24425,6 +26184,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -24466,8 +26230,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -24566,7 +26328,10 @@ export interface components { * @description A codespace. */ "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -24749,7 +26514,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -24789,6 +26557,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -24830,6 +26599,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -24909,6 +26679,45 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + "sigstore-bundle-0": { + mediaType?: string; + verificationMaterial?: { + x509CertificateChain?: { + certificates?: { + rawBytes?: string; + }[]; + }; + tlogEntries?: { + logIndex?: string; + logId?: { + keyId?: string; + }; + kindVersion?: { + kind?: string; + version?: string; + }; + integratedTime?: string; + inclusionPromise?: { + signedEntryTimestamp?: string; + }; + inclusionProof?: string | null; + canonicalizedBody?: string; + }[]; + timestampVerificationData?: string | null; + }; + dsseEnvelope?: { + payload?: string; + payloadType?: string; + signatures?: { + sig?: string; + keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -25041,6 +26850,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -25480,7 +27290,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -25541,75 +27351,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -25634,6 +27375,13 @@ export interface components { | "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -25806,6 +27554,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -25844,6 +27593,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -25913,6 +27663,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25932,6 +27683,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -25991,6 +27743,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26010,6 +27763,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26055,6 +27809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -26142,6 +27897,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26161,7 +27917,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -26219,6 +27977,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26238,6 +27997,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -26355,6 +28115,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26374,6 +28135,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -26431,6 +28193,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -26467,6 +28230,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -26562,6 +28326,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26692,6 +28457,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -26799,6 +28565,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -26833,6 +28605,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26852,6 +28625,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26900,6 +28674,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26973,6 +28748,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -27009,6 +28785,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -27104,6 +28881,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -27232,6 +29010,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -27339,6 +29118,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -27373,6 +29158,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27392,6 +29178,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -27430,6 +29217,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -27571,6 +29359,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -28010,7 +29799,7 @@ export interface components { allow_update_branch?: boolean; /** * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -28117,6 +29906,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -28170,6 +29960,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28189,6 +29980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -28257,6 +30049,10 @@ export interface components { | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -28312,6 +30108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -28368,6 +30165,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -28484,6 +30282,69 @@ export interface components { */ archived_at: string | null; }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-option": { + id: string; + name: string; + color?: string | null; + description?: string | null; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-setting": { + id: string; + title: string; + duration?: number | null; + start_date?: string | null; + }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + "projects-v2-status-update": { + id: number; + node_id: string; + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @enum {string|null} */ + status?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** + * Format: date + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -28530,7 +30391,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -28623,6 +30484,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -28719,6 +30581,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -28846,7 +30709,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -28939,6 +30805,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -29028,6 +30895,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29047,6 +30915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -29186,7 +31055,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -29279,6 +31151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -29368,6 +31241,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29387,6 +31261,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -29454,6 +31329,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -29501,6 +31377,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -29709,6 +31586,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29728,6 +31606,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -29862,6 +31741,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29881,6 +31761,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -29942,6 +31823,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29961,6 +31843,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -30067,6 +31950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -30214,6 +32098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -30354,6 +32239,11 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} @@ -30367,6 +32257,20 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -30374,6 +32278,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -30426,6 +32331,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -30465,6 +32371,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -30502,6 +32409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -30615,7 +32523,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -30625,7 +32533,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -30636,7 +32544,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -30647,7 +32555,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -30671,6 +32579,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync?: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -30684,7 +32606,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -30694,7 +32616,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -30712,7 +32634,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -30735,7 +32657,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -30753,7 +32675,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -30839,6 +32761,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -30878,6 +32802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31071,7 +32996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -31150,6 +33075,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -31189,6 +33116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31375,7 +33303,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -31449,6 +33377,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -31488,6 +33418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31673,7 +33604,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -31727,6 +33658,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31803,7 +33735,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -31857,6 +33789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31940,7 +33873,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -32015,9 +33948,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -32035,7 +33968,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -32089,6 +34022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -32174,7 +34108,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -32267,7 +34201,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -32351,7 +34285,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -32360,7 +34294,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -32427,6 +34361,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -32446,13 +34381,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; 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"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -32471,17 +34407,17 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -32493,18 +34429,18 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -32514,7 +34450,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -32533,7 +34469,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -32544,7 +34480,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -32555,7 +34491,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -32566,7 +34502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -32577,7 +34513,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -32588,7 +34524,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -32599,7 +34535,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -32610,7 +34546,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -32621,7 +34557,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -32632,7 +34568,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -32680,6 +34616,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -32793,6 +34730,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -32889,7 +34827,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -32929,6 +34867,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33179,6 +35118,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33206,7 +35146,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -33218,7 +35158,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -33269,6 +35209,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33345,6 +35286,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33457,6 +35399,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33519,6 +35462,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33538,7 +35482,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -33589,6 +35533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33664,6 +35609,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33776,6 +35722,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33837,6 +35784,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33893,11 +35841,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -33947,6 +35896,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -34022,6 +35972,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -34134,6 +36085,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -34196,6 +36148,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -34291,6 +36244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -34404,6 +36358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34535,6 +36490,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -34653,6 +36609,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34746,7 +36703,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -34786,6 +36743,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -35037,6 +36995,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -35056,7 +37015,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -35084,7 +37043,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -35095,7 +37054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -35107,7 +37066,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -35119,7 +37078,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -35136,7 +37095,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -35147,7 +37106,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -35158,7 +37117,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -35177,7 +37136,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -35189,7 +37148,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -35200,7 +37159,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -35211,7 +37170,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -35222,7 +37181,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -35237,7 +37196,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -35247,7 +37206,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -35259,7 +37218,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -35270,7 +37229,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -35281,7 +37240,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -35342,10 +37301,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -35402,7 +37357,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -35478,6 +37436,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -35629,13 +37588,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -35663,7 +37622,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -35675,7 +37634,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -35687,7 +37646,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -35699,7 +37658,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -35723,7 +37682,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -35747,7 +37706,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -35759,7 +37718,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -35799,6 +37758,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -35814,7 +37774,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -35827,7 +37787,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -35905,6 +37865,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35924,6 +37885,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -35973,6 +37935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36009,6 +37972,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36104,6 +38068,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36234,6 +38199,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36341,6 +38307,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36375,6 +38347,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36394,6 +38367,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36433,6 +38407,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -36495,6 +38470,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36510,7 +38486,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -36564,6 +38540,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36600,6 +38577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36695,6 +38673,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36823,6 +38802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36930,6 +38910,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36964,6 +38950,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36983,6 +38970,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -37022,6 +39010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -37084,6 +39073,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -37095,11 +39085,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -37154,6 +39145,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37190,6 +39182,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37285,6 +39278,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37415,6 +39409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37522,6 +39517,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37556,6 +39557,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37575,6 +39577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -37614,6 +39617,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -37676,6 +39680,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -37691,7 +39696,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -37706,7 +39711,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -37762,6 +39767,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37798,6 +39804,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37893,6 +39900,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38024,6 +40032,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38131,6 +40140,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38165,6 +40180,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38184,6 +40200,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -38232,6 +40249,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -38243,11 +40261,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -38303,6 +40322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38434,6 +40454,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38563,6 +40584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38670,6 +40692,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38704,6 +40732,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38723,11 +40752,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -38914,6 +40944,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39042,6 +41073,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39149,6 +41181,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39183,6 +41221,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39202,12 +41241,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -39274,6 +41314,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39405,6 +41446,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39536,6 +41578,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39643,6 +41686,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39677,6 +41726,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39696,12 +41746,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -39757,6 +41808,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39888,6 +41940,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40018,6 +42071,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40125,6 +42179,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40159,6 +42219,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40178,12 +42239,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -40239,6 +42301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40275,6 +42338,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40371,6 +42435,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40501,6 +42566,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40608,6 +42674,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40642,6 +42714,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40661,11 +42734,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -40852,6 +42926,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40981,6 +43056,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41088,6 +43164,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41122,6 +43204,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41141,12 +43224,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -41201,6 +43285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41237,6 +43322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -41332,6 +43418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41460,6 +43547,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41567,6 +43655,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41601,6 +43695,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41620,6 +43715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -41740,7 +43836,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -41816,6 +43915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -41916,6 +44016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41952,6 +44053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -42047,6 +44149,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42178,6 +44281,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42285,6 +44389,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42319,6 +44429,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42338,11 +44449,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -42353,7 +44465,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -42540,6 +44652,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42670,6 +44783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42777,6 +44891,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42811,6 +44931,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42830,11 +44951,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -42889,6 +45011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42925,6 +45048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43020,6 +45144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43148,6 +45273,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43255,6 +45381,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -43289,6 +45421,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43308,6 +45441,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -43431,7 +45565,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -43507,6 +45644,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43562,7 +45700,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -43577,7 +45715,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -43589,7 +45727,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -43645,6 +45783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43681,6 +45820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43777,6 +45917,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43905,6 +46046,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44012,6 +46154,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44046,6 +46194,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44065,11 +46214,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -44080,7 +46230,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -44091,7 +46241,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -44102,7 +46252,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -44128,7 +46278,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -44141,7 +46291,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -44180,7 +46330,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -44219,7 +46369,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -44258,7 +46408,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -44271,7 +46421,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -44298,7 +46448,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -44320,7 +46470,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -44331,7 +46481,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -44383,6 +46533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -44436,6 +46587,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -44446,7 +46598,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -44460,7 +46612,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -44543,7 +46695,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -44554,7 +46706,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -44565,7 +46717,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -44576,7 +46728,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -44602,7 +46754,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -44613,7 +46765,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -44624,7 +46776,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -44635,7 +46787,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -44646,7 +46798,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -44657,7 +46809,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -44712,6 +46864,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -44721,7 +46874,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -44733,7 +46886,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -44749,7 +46902,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -44823,6 +46976,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -44862,6 +47016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -44999,6 +47154,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -45034,7 +47190,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -45089,6 +47245,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -45128,6 +47285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -45199,6 +47357,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -45235,7 +47394,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -45283,6 +47442,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -45294,15 +47454,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { /** @enum {string} */ action: "approved"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -45310,8 +47471,9 @@ export interface components { /** @enum {string} */ action: "cancelled"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -45319,9 +47481,10 @@ export interface components { /** @enum {string} */ action: "created"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ "webhook-personal-access-token-request-denied": { @@ -45329,7 +47492,8 @@ export interface components { action: "denied"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -45376,7 +47540,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -45399,7 +47563,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -45410,7 +47574,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -45467,6 +47631,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -45480,7 +47645,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -45496,7 +47661,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -45557,6 +47722,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -45602,7 +47768,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -45613,7 +47779,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -45624,7 +47790,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -45635,7 +47801,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -45651,7 +47817,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -45662,7 +47828,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -45673,7 +47839,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -45684,7 +47850,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -45706,7 +47872,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -45717,7 +47883,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -45726,7 +47892,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -45735,7 +47901,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -45744,7 +47910,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -45771,7 +47937,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -45781,7 +47947,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -45796,7 +47962,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -45805,7 +47971,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -45814,18 +47980,36 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { field_value: { field_node_id?: string; field_type?: string; + field_name?: string; + project_number?: number; + from?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; + to?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; }; }, { @@ -45839,7 +48023,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -45854,7 +48038,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -45864,7 +48048,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -45873,7 +48057,70 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Created Event */ + "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Deleted Event */ + "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Edited Event */ + "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; + }; + status?: { + /** @enum {string|null} */ + from?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** @enum {string|null} */ + to?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + }; + start_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + target_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -45881,7 +48128,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -45980,6 +48227,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46016,6 +48264,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -46076,6 +48325,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -46203,7 +48453,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46296,6 +48549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46359,7 +48613,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46388,6 +48642,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46407,6 +48662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -46546,7 +48802,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46639,6 +48898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46702,7 +48962,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46731,6 +48991,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46750,6 +49011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -46817,6 +49079,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -46864,6 +49127,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46932,6 +49196,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -47072,6 +49337,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47091,10 +49357,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -47192,6 +49459,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47288,6 +49556,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -47415,7 +49684,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47508,6 +49780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47571,7 +49844,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47600,6 +49873,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47619,6 +49893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -47758,7 +50033,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47851,6 +50129,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47914,7 +50193,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47943,6 +50222,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47962,6 +50242,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -48029,6 +50310,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -48076,6 +50358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48144,6 +50427,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -48284,6 +50568,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48303,11 +50588,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -48405,6 +50691,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48501,6 +50788,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48628,7 +50916,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48721,6 +51012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48784,7 +51076,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48813,6 +51105,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48832,6 +51125,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -49064,6 +51358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49127,7 +51422,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49156,6 +51451,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49175,6 +51471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -49242,6 +51539,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -49289,6 +51587,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49357,6 +51656,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -49497,6 +51797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49516,11 +51817,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -49532,7 +51834,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -49544,7 +51846,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -49556,7 +51858,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -49654,6 +51956,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49750,6 +52053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -49877,7 +52181,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49970,6 +52277,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50033,7 +52341,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50062,6 +52370,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50081,6 +52390,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -50220,7 +52530,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50313,6 +52626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50376,7 +52690,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50405,6 +52719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50424,6 +52739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50491,6 +52807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -50538,6 +52855,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50606,6 +52924,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50746,6 +53065,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50765,11 +53085,25 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: + | "UNKNOWN_REMOVAL_REASON" + | "MANUAL" + | "MERGE" + | "MERGE_CONFLICT" + | "CI_FAILURE" + | "CI_TIMEOUT" + | "ALREADY_MERGED" + | "QUEUE_CLEARED" + | "ROLL_BACK" + | "BRANCH_PROTECTIONS" + | "GIT_TREE_INVALID" + | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -50800,7 +53134,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -50898,6 +53232,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50994,6 +53329,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -51121,7 +53457,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51214,6 +53553,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51277,7 +53617,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51306,6 +53646,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51325,6 +53666,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51464,7 +53806,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51557,6 +53902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51620,7 +53966,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51649,6 +53995,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51668,6 +54015,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -51735,6 +54083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -51782,6 +54131,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51850,6 +54200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -51990,6 +54341,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52009,10 +54361,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -52111,6 +54464,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52207,6 +54561,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52334,7 +54689,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52427,6 +54785,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52490,7 +54849,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52519,6 +54878,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52538,6 +54898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52677,7 +55038,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52770,6 +55134,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52833,7 +55198,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52862,6 +55227,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52881,6 +55247,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -52948,6 +55315,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -52995,6 +55363,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53063,6 +55432,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53203,6 +55573,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53222,10 +55593,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -53323,6 +55695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53419,6 +55792,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53546,7 +55920,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53639,6 +56016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53702,7 +56080,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53731,6 +56109,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53750,6 +56129,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53889,7 +56269,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53982,6 +56365,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54045,7 +56429,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54074,6 +56458,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54093,6 +56478,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54160,6 +56546,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54207,6 +56594,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54275,6 +56663,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -54415,6 +56804,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54434,10 +56824,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -54449,7 +56840,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -54461,7 +56852,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -54473,7 +56864,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -54485,7 +56876,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -54623,6 +57014,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54642,6 +57034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -54733,6 +57126,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54829,6 +57223,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54956,7 +57351,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55049,6 +57447,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55112,7 +57511,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55141,6 +57540,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55160,6 +57560,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55292,7 +57693,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55385,6 +57789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55448,7 +57853,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55477,6 +57882,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55496,6 +57902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55567,6 +57974,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55633,6 +58041,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -55767,6 +58176,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55786,10 +58196,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -55885,6 +58296,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55981,6 +58393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56108,7 +58521,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56201,6 +58617,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56264,7 +58681,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56293,6 +58710,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56312,6 +58730,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56444,7 +58863,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56537,6 +58959,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56600,7 +59023,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56629,6 +59052,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56648,6 +59072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56719,6 +59144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56785,6 +59211,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56919,6 +59346,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56938,10 +59366,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -57038,6 +59467,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57074,6 +59504,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -57134,6 +59565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57261,7 +59693,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57354,6 +59789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57417,7 +59853,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57446,6 +59882,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57465,6 +59902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -57597,7 +60035,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57690,6 +60131,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57753,7 +60195,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57782,6 +60224,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57801,6 +60244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57872,6 +60316,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57938,6 +60383,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -58072,6 +60518,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58089,12 +60536,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -58190,6 +60638,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58286,6 +60735,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -58413,7 +60863,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58506,6 +60959,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58569,7 +61023,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58598,6 +61052,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58617,6 +61072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58749,7 +61205,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58842,6 +61301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58905,7 +61365,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58934,6 +61394,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58953,6 +61414,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59024,6 +61486,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59090,6 +61553,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -59224,6 +61688,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59243,6 +61708,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -59306,6 +61772,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59325,9 +61792,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -59429,6 +61897,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59525,6 +61994,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59647,7 +62117,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59723,6 +62196,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59788,6 +62262,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59807,6 +62282,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59934,7 +62410,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60010,6 +62489,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60075,6 +62555,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60094,6 +62575,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60165,6 +62647,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60231,6 +62714,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -60365,6 +62849,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60384,11 +62869,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -60489,6 +62975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60525,6 +63012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -60585,6 +63073,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60712,7 +63201,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60805,6 +63297,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60861,7 +63354,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60890,6 +63383,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60909,6 +63403,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61048,7 +63543,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61141,6 +63639,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61204,7 +63703,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61233,6 +63732,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61252,6 +63752,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61319,6 +63820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -61366,6 +63868,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61434,6 +63937,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61574,6 +64078,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61593,6 +64098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -61632,8 +64138,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -61731,6 +64238,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61767,6 +64275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -61827,6 +64336,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61954,7 +64464,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62047,6 +64560,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62110,7 +64624,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62139,6 +64653,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62158,6 +64673,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62297,7 +64813,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62390,6 +64909,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62453,7 +64973,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62482,6 +65002,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62501,6 +65022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62568,6 +65090,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -62615,6 +65138,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62683,6 +65207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -62823,6 +65348,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62842,6 +65368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -62900,7 +65427,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -63003,6 +65530,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63039,6 +65567,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63099,6 +65628,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63226,7 +65756,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63319,6 +65852,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63382,7 +65916,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63411,6 +65945,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63430,6 +65965,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63569,7 +66105,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63662,6 +66201,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63725,7 +66265,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63754,6 +66294,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63773,6 +66314,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63840,6 +66382,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -63887,6 +66430,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63955,6 +66499,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -64095,6 +66640,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64114,6 +66660,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -64153,8 +66700,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -64252,6 +66800,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64288,6 +66837,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -64348,6 +66898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64475,7 +67026,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64568,6 +67122,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64631,7 +67186,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64660,6 +67215,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64679,6 +67235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64818,7 +67375,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64911,6 +67471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64974,7 +67535,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65003,6 +67564,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65022,6 +67584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65089,6 +67652,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -65136,6 +67700,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65204,6 +67769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -65344,6 +67910,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65363,6 +67930,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -65421,7 +67989,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -65519,6 +68087,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65615,6 +68184,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65742,7 +68312,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65835,6 +68408,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65898,7 +68472,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65927,6 +68501,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65946,6 +68521,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66078,7 +68654,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66171,6 +68750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66234,7 +68814,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66263,6 +68843,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66282,6 +68863,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66353,6 +68935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66419,6 +69002,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -66553,6 +69137,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66572,11 +69157,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -66672,6 +69258,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66768,6 +69355,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66895,7 +69483,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66971,6 +69562,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67038,6 +69630,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67057,6 +69650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67189,7 +69783,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67265,6 +69862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67332,6 +69930,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67351,6 +69950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67422,6 +70022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67488,6 +70089,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67622,6 +70224,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67641,10 +70244,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -67774,6 +70378,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67793,6 +70398,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -67892,6 +70498,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67988,6 +70595,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68115,7 +70723,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68191,6 +70802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68258,6 +70870,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68277,6 +70890,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68409,7 +71023,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68485,6 +71102,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68552,6 +71170,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68571,6 +71190,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68642,6 +71262,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68708,6 +71329,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -68842,6 +71464,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68861,10 +71484,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -68994,6 +71618,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69013,6 +71638,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -69116,6 +71742,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69212,6 +71839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69339,7 +71967,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69432,6 +72063,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69495,7 +72127,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69524,6 +72156,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69543,6 +72176,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -69682,7 +72316,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69768,6 +72405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69831,7 +72469,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69860,6 +72498,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69879,6 +72518,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69946,6 +72586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69993,6 +72634,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70061,6 +72703,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -70201,6 +72844,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70220,10 +72864,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -70322,6 +72967,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70418,6 +73064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70545,7 +73192,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70638,6 +73288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70701,7 +73352,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -70730,6 +73381,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70749,6 +73401,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70888,7 +73541,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70981,6 +73637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71044,7 +73701,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -71073,6 +73730,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71092,6 +73750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -71159,6 +73818,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -71206,6 +73866,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -71274,6 +73935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -71414,6 +74076,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71433,10 +74096,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -71535,6 +74199,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -71631,6 +74296,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -71758,7 +74424,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71851,6 +74520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71914,7 +74584,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -71943,6 +74613,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71962,6 +74633,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -72101,7 +74773,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72187,6 +74862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72250,7 +74926,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -72279,6 +74955,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72298,6 +74975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72365,6 +75043,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -72412,6 +75091,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72480,6 +75160,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -72620,6 +75301,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72639,10 +75321,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -72740,6 +75423,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72836,6 +75520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72963,7 +75648,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73056,6 +75744,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73119,7 +75808,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73148,6 +75837,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73167,6 +75857,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73306,7 +75997,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73399,6 +76093,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73462,7 +76157,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73491,6 +76186,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73510,6 +76206,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73577,6 +76274,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -73624,6 +76322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73692,6 +76391,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -73832,6 +76532,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73851,10 +76552,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -74112,7 +76814,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74188,6 +76893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74237,7 +76943,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -74272,6 +76978,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -74294,6 +77001,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -74412,6 +77120,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -74442,7 +77151,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -74477,6 +77186,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -74499,6 +77209,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -74551,6 +77262,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -74575,7 +77287,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -74586,7 +77298,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -74597,7 +77309,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -74622,7 +77334,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -74734,6 +77446,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -74782,7 +77495,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -74793,7 +77506,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -74804,7 +77517,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -74815,7 +77528,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -74826,7 +77539,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -74837,7 +77550,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -74847,7 +77560,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -74857,7 +77570,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -74867,7 +77580,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -74882,7 +77595,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -74906,7 +77619,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -74914,7 +77627,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -74926,7 +77639,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -74936,7 +77649,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -74953,7 +77666,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -74964,7 +77677,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -74975,7 +77688,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -75033,7 +77746,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -75084,6 +77797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75103,6 +77817,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -75111,7 +77826,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -75121,7 +77836,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -75132,7 +77847,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -75185,6 +77900,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -75205,7 +77921,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -75216,7 +77932,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -75288,7 +78004,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -75299,7 +78015,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -75310,13 +78026,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + 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"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -75326,7 +78053,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -75337,29 +78064,61 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - action: "revoked"; + action: "validated"; alert: components["schemas"]["secret-scanning-alert-webhook"]; 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"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert validated event */ - "webhook-secret-scanning-alert-validated": { + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { /** @enum {string} */ - action: "validated"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: + | "repository" + | "organization" + | "enterprise" + | null; + repository?: components["schemas"]["repository-webhooks"]; 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"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -75370,7 +78129,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -75381,7 +78140,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -75397,6 +78156,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -75428,7 +78188,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -75441,7 +78201,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -75451,7 +78211,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -75462,7 +78222,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -75479,7 +78239,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -75491,7 +78251,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -75504,7 +78264,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -75516,7 +78276,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -75527,7 +78287,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -75539,7 +78299,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -75654,6 +78414,7 @@ export interface components { | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -75718,7 +78479,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -75730,13 +78491,77 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** team_add event */ "webhook-team-add": { 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"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -75862,256 +78687,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** 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; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - team: components["schemas"]["webhooks_team_1"]; - }; - /** team created event */ - "webhook-team-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - /** - * Repository - * @description A git repository - */ - repository?: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true + * Format: int64 + * @description Unique identifier of the repository */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76187,6 +78766,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76234,7 +78814,260 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; + }; + /** team created event */ + "webhook-team-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + /** + * Repository + * @description A git repository + */ + repository?: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** 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; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + }; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -76360,7 +79193,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76436,6 +79272,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76483,7 +79320,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -76640,7 +79477,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76716,6 +79556,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76763,7 +79604,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -76889,7 +79730,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76965,6 +79809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77012,7 +79857,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -77023,7 +79868,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -77035,7 +79880,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -77046,7 +79891,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77151,7 +79996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77249,7 +80094,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77303,7 +80148,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77362,7 +80207,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -77402,6 +80247,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -77421,6 +80267,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -77561,6 +80408,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -77735,6 +80583,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -77809,6 +80658,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -77832,7 +80682,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -78296,7 +81146,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -78336,6 +81186,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -78496,6 +81347,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -78670,6 +81522,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -78744,6 +81597,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -78804,12 +81658,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { content: { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description A header with no content is returned. */ + no_content: { + content: never; + }; /** @description Service unavailable */ service_unavailable: { content: { @@ -78840,8 +81698,14 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { content: { "application/json": components["schemas"]["basic-error"]; }; @@ -78874,14 +81738,16 @@ export interface components { }; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { content: never; }; - /** @description A header with no content is returned. */ - no_content: { - content: never; - }; /** @description Gone */ gone: { content: { @@ -78906,6 +81772,18 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { content: never; @@ -78964,6 +81842,8 @@ export interface components { "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: string; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * @@ -79006,11 +81886,7 @@ export interface components { "pagination-last"?: number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type"?: string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution"?: string; @@ -79018,6 +81894,10 @@ export interface components { "secret-scanning-alert-sort"?: "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ "secret-scanning-alert-validity"?: string; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked"?: boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo"?: boolean; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -79046,8 +81926,20 @@ export interface components { "since-org"?: number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year"?: number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month"?: number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day"?: number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour"?: number; /** @description The unique identifier of the repository. */ "repository-id": number; + /** @description Only return runner groups that are allowed to be used by this repository. */ + "visible-to-repository"?: string; + /** @description Unique identifier of the self-hosted runner group. */ + "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ @@ -79066,6 +81958,46 @@ export interface components { "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; /** @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 type of the actor */ + "api-insights-actor-type": + | "installation" + | "classic_pat" + | "fine_grained_pat" + | "oauth_app" + | "github_app_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-max-timestamp"?: string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "http_method" + | "api_route" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring"?: string; + /** @description The property to sort the results by. */ + "api-insights-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "subject_name" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring"?: string; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring"?: string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -79111,10 +82043,18 @@ 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. */ + /** @description The custom property name */ "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 A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + */ + "ruleset-targets"?: string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ + "ref-in-query"?: string; + /** @description The name of the repository to filter on. */ + "repository-name-in-query"?: string; /** * @description The time period to filter by. * @@ -79233,6 +82173,8 @@ export interface components { status?: "queued" | "in_progress" | "completed"; /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ "git-ref"?: components["schemas"]["code-scanning-ref"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias"?: number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -79281,8 +82223,6 @@ 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. */ @@ -79399,13 +82339,23 @@ export interface operations { * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** + * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; direction?: components["parameters"]["direction"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description The property to sort the results by. */ - sort?: "updated" | "published"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; }; responses: { @@ -79540,7 +82490,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -80108,8 +83057,6 @@ export interface operations { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ "apps/create-installation-access-token": { @@ -80189,7 +83136,7 @@ export interface operations { }; /** * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ "apps/delete-authorization": { @@ -80216,7 +83163,7 @@ export interface operations { }; /** * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -80245,7 +83192,7 @@ export interface operations { }; /** * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -80271,7 +83218,7 @@ export interface operations { }; /** * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -80304,10 +83251,6 @@ export interface operations { * token. * * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. */ "apps/scope-token": { parameters: { @@ -80361,7 +83304,8 @@ export interface operations { }; /** * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + * @description > [!NOTE] + * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ "apps/get-by-slug": { parameters: { @@ -80560,48 +83504,469 @@ export interface operations { }; }; /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-configurations-for-enterprise": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/create-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-default-configurations-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + }; + }; + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-single-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/update-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/attach-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; }; path: { enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; }; }; responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; /** @@ -80669,6 +84034,8 @@ export interface operations { before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { enterprise: components["parameters"]["enterprise"]; @@ -80690,7 +84057,8 @@ export interface operations { }; /** * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-public-events": { parameters: { @@ -80725,7 +84093,8 @@ export interface operations { * * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * > [!NOTE] + * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -80767,7 +84136,8 @@ export interface operations { * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * > [!NOTE] + * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ "gists/create": { requestBody: { @@ -81378,10 +84748,8 @@ export interface operations { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -81538,7 +84906,7 @@ export interface operations { * Get a subscription plan for an account * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account": { parameters: { @@ -81566,7 +84934,7 @@ export interface operations { * List plans * @description Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans": { parameters: { @@ -81593,7 +84961,7 @@ export interface operations { * List accounts for a plan * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan": { parameters: { @@ -81627,7 +84995,7 @@ export interface operations { * Get a subscription plan for an account (stubbed) * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account-stubbed": { parameters: { @@ -81653,7 +85021,7 @@ export interface operations { * List plans (stubbed) * @description Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans-stubbed": { parameters: { @@ -81679,7 +85047,7 @@ export interface operations { * List accounts for a plan (stubbed) * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan-stubbed": { parameters: { @@ -81715,7 +85083,8 @@ export interface operations { * * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * > [!NOTE] + * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ "meta/get": { responses: { @@ -81728,7 +85097,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-repo-network": { parameters: { query?: { @@ -81984,7 +85357,8 @@ export interface operations { * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * > [!NOTE] + * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ "orgs/list": { parameters: { @@ -82007,6 +85381,32 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + year?: components["parameters"]["billing-usage-report-year"]; + month?: components["parameters"]["billing-usage-report-month"]; + day?: components["parameters"]["billing-usage-report-day"]; + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get an organization * @description Gets information about an organization. @@ -82015,17 +85415,6 @@ export interface operations { * * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. @@ -82070,20 +85459,13 @@ export interface operations { }; /** * Update an organization - * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - * - * Updates the organization's profile and member privileges. + * @description > [!WARNING] + * > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -82135,7 +85517,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -82167,7 +85549,10 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -82175,7 +85560,10 @@ export interface operations { */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -82183,7 +85571,10 @@ export interface operations { */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -82191,7 +85582,10 @@ export interface operations { */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -82199,7 +85593,10 @@ export interface operations { */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -82207,7 +85604,10 @@ export interface operations { */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. * * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * @@ -82218,6 +85618,8 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -82583,6 +85985,376 @@ export interface operations { }; }; }; + /** + * List self-hosted runner groups for an organization + * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runner-groups-for-org": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + /** + * Create a self-hosted runner group for an organization + * @description Creates a new self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** @description List of runner IDs to add to the runner group. */ + runners?: number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + /** + * Get a self-hosted runner group for an organization + * @description Gets a specific self-hosted runner group for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + /** + * Delete a self-hosted runner group from an organization + * @description Deletes a self-hosted runner group for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Update a self-hosted runner group for an organization + * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: boolean; + /** + * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + * @default false + */ + restricted_to_workflows?: boolean; + /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ + selected_workflows?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["runner-groups-org"]; + }; + }; + }; + }; + /** + * List repository access to a self-hosted runner group in an organization + * @description Lists the repositories with access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/list-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + query?: { + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + }; + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + /** + * Set repository access for a self-hosted runner group in an organization + * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/set-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Add repository access to a self-hosted runner group in an organization + * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/add-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + repository_id: components["parameters"]["repository-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Remove repository access to a self-hosted runner group in an organization + * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + repository_id: components["parameters"]["repository-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * List self-hosted runners in a group for an organization + * @description Lists self-hosted runners that are in a specific organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/list-self-hosted-runners-in-group-for-org": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + /** + * Set self-hosted runners in a group for an organization + * @description Replaces the list of self-hosted runners that are part of an organization runner group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/set-self-hosted-runners-in-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description List of runner IDs to add to the runner group. */ + runners: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Add a self-hosted runner to a group for an organization + * @description Adds a self-hosted runner to a runner group configured in an organization. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/add-self-hosted-runner-to-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + runner_id: components["parameters"]["runner-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; + /** + * Remove a self-hosted runner from a group for an organization + * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "actions/remove-self-hosted-runner-from-group-for-org": { + parameters: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + runner_id: components["parameters"]["runner-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. @@ -83536,6 +87308,54 @@ export interface operations { }; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "orgs/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * List users blocked by an organization * @description List the users blocked by an organization. @@ -83663,6 +87483,546 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration + * @description Creates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/create-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-default-configurations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/detach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/delete-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a code security configuration + * @description Updates a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/update-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + content: never; + }; + }; + }; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/attach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: + | "all" + | "all_without_configurations" + | "public" + | "private_or_internal" + | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/set-configuration-as-default": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an organization. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + "code-security/get-repositories-for-configuration": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; + }; + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. @@ -84085,15 +88445,16 @@ export interface operations { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * and feature policies. To configure these settings, go to your organization's settings on GitHub.com. + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. + * Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-organization-details": { parameters: { @@ -84120,13 +88481,16 @@ export interface operations { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/list-copilot-seats": { parameters: { @@ -84161,18 +88525,19 @@ export interface operations { }; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/add-copilot-seats-for-teams": { parameters: { @@ -84209,18 +88574,18 @@ export interface operations { }; /** * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * Only organization owners can cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/cancel-copilot-seat-assignment-for-teams": { parameters: { @@ -84257,18 +88622,19 @@ export interface operations { }; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/add-copilot-seats-for-users": { parameters: { @@ -84305,18 +88671,18 @@ export interface operations { }; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Only organization owners can cancel Copilot seats for their organization members. * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * The response contains the total number of seats set to "pending cancellation". * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/cancel-copilot-seat-assignment-for-users": { parameters: { @@ -84351,22 +88717,66 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-organization": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. + * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-org": { parameters: { @@ -84786,7 +89196,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization events + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-org-events": { parameters: { query?: { @@ -84835,7 +89249,9 @@ export interface operations { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -84953,7 +89369,9 @@ export interface operations { }; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -85105,7 +89523,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -85199,6 +89616,240 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + "api-insights/get-route-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-route-stats-sort"]; + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; + }; + }; + }; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + "api-insights/get-subject-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-subject-stats"]; + }; + }; + }; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + "api-insights/get-summary-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + "api-insights/get-summary-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + "api-insights/get-time-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + "api-insights/get-time-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + "api-insights/get-time-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + "api-insights/get-user-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; + }; + }; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. @@ -85319,7 +89970,10 @@ export interface operations { }; /** * List pending organization invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * @description The return hash contains a `role` field which refers to the Organization + * Invitation role and will be one of the following values: `direct_member`, `admin`, + * `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub + * member, the `login` field in the return hash will be `null`. */ "orgs/list-pending-invitations": { parameters: { @@ -85357,7 +90011,7 @@ export interface operations { * Create an organization invitation * @description Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ "orgs/create-invitation": { @@ -85453,10 +90107,8 @@ export interface operations { * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -85670,13 +90322,17 @@ export interface operations { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * Only organization owners can view Copilot seat assignment details for members of their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-seat-details-for-user": { parameters: { @@ -85734,7 +90390,7 @@ export interface operations { * * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ "orgs/set-membership-for-user": { parameters: { @@ -86014,39 +90670,9 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - "orgs/list-organization-fine-grained-permissions": { - parameters: { - path: { - org: components["parameters"]["org"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -86077,50 +90703,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - "orgs/create-custom-organization-role": { - parameters: { - path: { - org: components["parameters"]["org"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86142,7 +90727,7 @@ export interface operations { }; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86173,7 +90758,7 @@ export interface operations { }; /** * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86196,7 +90781,7 @@ export interface operations { }; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86218,7 +90803,7 @@ export interface operations { }; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86249,7 +90834,7 @@ export interface operations { }; /** * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86272,7 +90857,7 @@ export interface operations { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -86299,77 +90884,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - "orgs/delete-custom-organization-role": { - parameters: { - path: { - org: components["parameters"]["org"]; - role_id: components["parameters"]["role-id"]; - }; - }; - responses: { - /** @description Response */ - 204: { - content: never; - }; - }; - }; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ - "orgs/patch-custom-organization-role": { - parameters: { - path: { - org: components["parameters"]["org"]; - role_id: components["parameters"]["role-id"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions?: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -86393,7 +90910,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -86408,7 +90925,7 @@ export interface operations { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -86432,7 +90949,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["user-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -86544,7 +91061,7 @@ export interface operations { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-organization": { parameters: { @@ -86583,7 +91100,7 @@ export interface operations { * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-organization": { parameters: { @@ -86608,7 +91125,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-org": { parameters: { @@ -86638,7 +91155,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-org": { parameters: { @@ -86666,7 +91183,7 @@ export interface operations { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { @@ -86698,7 +91215,7 @@ export interface operations { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-organization": { parameters: { @@ -86724,7 +91241,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-org": { parameters: { @@ -86755,7 +91272,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-org": { parameters: { @@ -87055,6 +91572,232 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/list-org-private-registries": { + 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": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/create-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-public-key": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/delete-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/update-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. @@ -87133,7 +91876,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -87158,7 +91901,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -87166,7 +91909,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -87189,7 +91932,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -87213,32 +91956,14 @@ export interface operations { }; 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 | string[] | null; - /** @description Short description of the property */ - description?: string | null; - /** - * @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. - */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -87427,7 +92152,8 @@ export interface operations { * List organization repositories * @description Lists repositories for the specified organization. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/list-for-org": { parameters: { @@ -87552,12 +92278,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -87574,7 +92302,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -87621,6 +92351,7 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; }; path: { org: components["parameters"]["org"]; @@ -87655,11 +92386,10 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -87688,6 +92418,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + ref?: components["parameters"]["ref-in-query"]; repository_name?: components["parameters"]["repository-name-in-query"]; time_period?: components["parameters"]["time-period"]; actor_name?: components["parameters"]["actor-name-in-query"]; @@ -87736,6 +92467,9 @@ export interface operations { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-org-ruleset": { parameters: { @@ -87776,11 +92510,9 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -87843,6 +92575,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { org: components["parameters"]["org"]; @@ -87900,11 +92634,9 @@ export interface operations { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/list-security-manager-teams": { parameters: { @@ -87923,11 +92655,9 @@ export interface operations { }; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/add-security-manager-team": { parameters: { @@ -87941,19 +92671,13 @@ export interface operations { 204: { content: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - content: never; - }; }; }; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/remove-security-manager-team": { parameters: { @@ -88038,24 +92762,70 @@ export interface operations { }; }; }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + since?: string; + /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ + until?: string; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + }; + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, * they must have telemetry enabled in their IDE. * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-team": { parameters: { @@ -88159,7 +92929,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -88184,7 +92954,8 @@ export interface operations { * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ "teams/get-by-name": { parameters: { @@ -88209,7 +92980,8 @@ export interface operations { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ "teams/delete-in-org": { parameters: { @@ -88229,7 +93001,8 @@ export interface operations { * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ "teams/update-in-org": { parameters: { @@ -88265,7 +93038,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -88297,7 +93070,8 @@ export interface operations { * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -88331,9 +93105,10 @@ export interface operations { * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88372,7 +93147,8 @@ export interface operations { * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -88397,7 +93173,8 @@ export interface operations { * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88420,7 +93197,8 @@ export interface operations { * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88455,7 +93233,8 @@ export interface operations { * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -88488,9 +93267,10 @@ export interface operations { * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88523,7 +93303,8 @@ export interface operations { * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -88549,7 +93330,8 @@ export interface operations { * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88573,7 +93355,8 @@ export interface operations { * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88607,7 +93390,8 @@ export interface operations { * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -88652,7 +93436,8 @@ export interface operations { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88701,7 +93486,8 @@ export interface operations { }; /** * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -88728,7 +93514,8 @@ export interface operations { * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ @@ -88772,7 +93559,8 @@ export interface operations { * * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -88820,7 +93608,8 @@ export interface operations { }; /** * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -88846,7 +93635,8 @@ export interface operations { * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ "teams/list-pending-invitations-in-org": { parameters: { @@ -88908,10 +93698,11 @@ export interface operations { * * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * > [!NOTE] + * > The response contains the `state` of the membership and the member's `role`. * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ @@ -88942,13 +93733,15 @@ export interface operations { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -88993,9 +93786,11 @@ export interface operations { * * Team synchronization is available for organizations using 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. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -89020,7 +93815,8 @@ export interface operations { * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ "teams/list-projects-in-org": { parameters: { @@ -89049,7 +93845,8 @@ export interface operations { * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/check-permissions-for-project-in-org": { parameters: { @@ -89076,7 +93873,8 @@ export interface operations { * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -89117,7 +93915,8 @@ export interface operations { * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ "teams/remove-project-in-org": { parameters: { @@ -89138,7 +93937,8 @@ export interface operations { * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ "teams/list-repos-in-org": { parameters: { @@ -89167,13 +93967,14 @@ export interface operations { * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/check-permissions-for-repo-in-org": { parameters: { @@ -89205,7 +94006,8 @@ export interface operations { * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ @@ -89221,10 +94023,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -89240,7 +94039,8 @@ export interface operations { * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ "teams/remove-repo-in-org": { parameters: { @@ -89262,7 +94062,8 @@ export interface operations { * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * > [!NOTE] + * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ "teams/list-child-in-org": { parameters: { @@ -89289,11 +94090,15 @@ export interface operations { }; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -89983,7 +94788,8 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @description > [!NOTE] + * > Accessing this endpoint does not count against your REST API rate limit. * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -89994,9 +94800,10 @@ export interface operations { * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * > [!NOTE] + * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ "rate-limit/get": { responses: { @@ -90019,7 +94826,8 @@ export interface operations { * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * - * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > [!NOTE] + * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ "repos/get": { parameters: { @@ -90131,6 +94939,16 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -90186,12 +95004,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -90208,7 +95028,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -91231,7 +96053,7 @@ export interface operations { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs-for-repo": { parameters: { @@ -91526,8 +96348,8 @@ export interface operations { * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * > [!NOTE] + * > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ @@ -92276,6 +97098,8 @@ export interface operations { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ "actions/list-workflow-runs": { parameters: { @@ -92455,6 +97279,103 @@ export interface operations { }; }; }; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/create-attestation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description response */ + 201: { + content: { + "application/json": { + /** @description The ID of the attestation. */ + id?: number; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. @@ -92575,13 +97496,13 @@ export interface operations { }; }; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { content: never; }; @@ -92627,7 +97548,7 @@ export interface operations { "repos/list-branches": { parameters: { query?: { - /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -92698,9 +97619,11 @@ export interface operations { * * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * > [!NOTE] + * > The list of users, apps, and teams in total is limited to 100 items. */ "repos/update-branch-protection": { parameters: { @@ -92719,7 +97642,7 @@ export interface operations { strict: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -92941,7 +97864,8 @@ export interface operations { * * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * > [!NOTE] + * > Passing new arrays of `users` and `teams` replaces their previous values. */ "repos/update-pull-request-review-protection": { parameters: { @@ -93002,7 +97926,8 @@ export interface operations { * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * > [!NOTE] + * > You must enable branch protection to require signed commits. */ "repos/get-commit-signature-protection": { parameters: { @@ -93130,7 +98055,7 @@ export interface operations { strict?: boolean; /** * @deprecated - * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -93276,7 +98201,8 @@ export interface operations { * * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * > [!NOTE] + * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ "repos/get-access-restrictions": { parameters: { @@ -93355,7 +98281,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93387,7 +98313,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93419,7 +98345,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93599,7 +98525,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93635,7 +98561,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93671,7 +98597,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93693,7 +98619,8 @@ export interface operations { * Rename a branch * @description Renames a branch in a repository. * - * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + * > [!NOTE] + * > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * @@ -93850,7 +98777,8 @@ export interface operations { * Get a check run * @description Gets a single check run using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -93875,7 +98803,8 @@ export interface operations { * Update a check run * @description Updates a check run for a specific commit in a 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. + * > [!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. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -94077,7 +99006,8 @@ export interface operations { * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **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`. + * > [!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`. * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ @@ -94152,7 +99082,8 @@ export interface operations { * Get a check suite * @description Gets a single check suite using its `id`. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -94177,7 +99108,8 @@ export interface operations { * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **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. + * > [!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. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -94341,6 +99273,112 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/get-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/create-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/commit-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. @@ -94353,6 +99391,7 @@ export interface operations { page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; ref?: components["parameters"]["git-ref"]; + pr?: components["parameters"]["pr-alias"]; }; path: { owner: components["parameters"]["owner"]; @@ -94385,8 +99424,8 @@ export interface operations { * For very old analyses this data is not available, * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -94397,6 +99436,7 @@ export interface operations { tool_guid?: components["parameters"]["tool-guid"]; page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; + pr?: components["parameters"]["pr-alias"]; /** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ @@ -94563,7 +99603,7 @@ export interface operations { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ "code-scanning/list-codeql-databases": { parameters: { @@ -94590,11 +99630,11 @@ export interface operations { * * By default this endpoint returns JSON metadata about the CodeQL database. To * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure + * to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ "code-scanning/get-codeql-database": { parameters: { @@ -94618,6 +99658,138 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/delete-codeql-database": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "code-scanning/create-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description A Base64-encoded tarball containing a CodeQL query and all its dependencies */ + query_pack: string; + /** @description List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repositories?: string[]; + /** @description List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_lists?: string[]; + /** @description List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_owners?: string[]; + }; + }; + }; + responses: { + /** @description Variant analysis submitted for processing */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unable to process variant analysis submission */ + 422: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/get-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The unique identifier of the variant analysis. */ + codeql_variant_analysis_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + "code-scanning/get-variant-analysis-repo-task": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + /** @description The name of the controller repository. */ + repo: string; + /** @description The ID of the variant analysis. */ + codeql_variant_analysis_id: number; + /** @description The account owner of the variant analysis repository. The name is not case sensitive. */ + repo_owner: string; + /** @description The name of the variant analysis repository. */ + repo_name: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. @@ -94714,6 +99886,8 @@ export interface operations { * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -94799,6 +99973,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "code-security/get-configuration-for-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS @@ -94885,7 +100087,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -95113,8 +100315,6 @@ export interface operations { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ "codespaces/get-repo-public-key": { @@ -95285,7 +100485,7 @@ export interface operations { }; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -95364,7 +100564,8 @@ export interface operations { * - If the user had their own fork of the repository, the fork will be deleted. * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * > [!NOTE] + * > A user can still have access to the repository through organization permissions like base repository permissions. * * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * @@ -95620,7 +100821,8 @@ export interface operations { }; /** * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ @@ -95652,6 +100854,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95682,8 +100885,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - since?: components["parameters"]["since"]; - /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -95773,7 +100977,7 @@ export interface operations { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -95799,7 +101003,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -95854,7 +101058,8 @@ export interface operations { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * > [!NOTE] + * > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * @@ -95872,6 +101077,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95921,7 +101127,8 @@ export interface operations { * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **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. + * > [!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. * @@ -95963,7 +101170,8 @@ export interface operations { * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **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`. + * > [!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`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ @@ -96113,7 +101321,7 @@ export interface operations { * * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: * - * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison. + * - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. * * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)." @@ -96128,6 +101336,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -96226,6 +101435,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -96234,7 +101444,8 @@ export interface operations { * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ @@ -96293,7 +101504,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -96307,7 +101525,8 @@ export interface operations { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * > [!NOTE] + * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ "repos/delete-file": { parameters: { @@ -96411,7 +101630,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -97019,7 +102238,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -97104,7 +102326,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -97157,7 +102379,8 @@ export interface operations { }; /** * Get an environment - * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + * @description > [!NOTE] + * > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * * Anyone with read access to the repository can use this endpoint. * @@ -97184,9 +102407,11 @@ export interface operations { * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * > [!NOTE] + * > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * > [!NOTE] + * > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -97470,7 +102695,9 @@ export interface operations { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * @@ -97865,7 +103092,8 @@ export interface operations { }; /** * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-repo-events": { parameters: { @@ -97918,9 +103146,11 @@ export interface operations { * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * > [!NOTE] + * > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * > [!NOTE] + * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ "repos/create-fork": { parameters: { @@ -97989,7 +103219,14 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** @@ -98038,6 +103275,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98071,7 +103309,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -98134,6 +103372,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98178,7 +103417,8 @@ export interface operations { * * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ @@ -98207,7 +103447,8 @@ export interface operations { * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * > [!NOTE] + * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ "git/get-ref": { parameters: { @@ -98335,6 +103576,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98417,6 +103659,7 @@ export interface operations { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98531,8 +103774,8 @@ export interface operations { * * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * > [!NOTE] + * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ "git/get-tree": { parameters: { @@ -98664,7 +103907,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -98792,7 +104040,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -98878,7 +104125,8 @@ export interface operations { * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * > [!NOTE] + * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ "repos/test-push-webhook": { parameters: { @@ -98901,7 +104149,8 @@ export interface operations { * @deprecated * @description View the progress of an import. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -98961,7 +104210,8 @@ export interface operations { * 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99010,7 +104260,8 @@ export interface operations { * @deprecated * @description Stop an import for a repository. * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99037,7 +104288,8 @@ 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99084,7 +104336,8 @@ export interface operations { * * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99113,7 +104366,8 @@ export interface operations { * @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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99150,7 +104404,8 @@ export interface operations { * @deprecated * @description List files larger than 100MB found during the import * - * **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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99178,7 +104433,8 @@ export interface operations { * 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:** 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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99382,10 +104638,8 @@ export interface operations { * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -99439,7 +104693,7 @@ export interface operations { * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -99463,7 +104717,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ body?: string; - /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ + /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */ assignee?: string | null; milestone?: string | number | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ @@ -99717,7 +104971,8 @@ export interface operations { }; /** * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ @@ -99798,10 +105053,8 @@ export interface operations { * access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe * to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -99833,7 +105086,7 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role can edit an issue. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -99857,7 +105110,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -100037,7 +105290,7 @@ export interface operations { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -100421,7 +105674,8 @@ export interface operations { }; /** * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ @@ -100441,6 +105695,173 @@ export interface operations { }; }; }; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + "issues/remove-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + "issues/list-sub-issues": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + "issues/add-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + "issues/reprioritize-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. @@ -101142,7 +106563,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -101713,7 +107134,7 @@ export interface operations { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -101986,7 +107407,8 @@ export interface operations { }; /** * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ @@ -102022,7 +107444,7 @@ export interface operations { * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -102041,7 +107463,7 @@ export interface operations { }; }; responses: { - /** @description Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ + /** @description Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -102125,7 +107547,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -102213,9 +107635,9 @@ export interface operations { * * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -102244,7 +107666,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -102293,7 +107715,7 @@ export interface operations { * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -102375,8 +107797,8 @@ export interface operations { * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * > [!NOTE] + * > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -102438,7 +107860,7 @@ export interface operations { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ "pulls/merge": { parameters: { @@ -102626,11 +108048,12 @@ export interface operations { * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * > [!NOTE] + * > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * @@ -102832,9 +108255,8 @@ export interface operations { * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * > [!NOTE] + * > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -102924,6 +108346,7 @@ export interface operations { /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -102982,6 +108405,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -103053,7 +108477,7 @@ export interface operations { * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ "repos/create-release": { parameters: { @@ -103121,7 +108545,13 @@ export interface operations { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ "repos/get-release-asset": { parameters: { @@ -103275,9 +108705,8 @@ export interface operations { * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * > [!NOTE] + * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ "repos/get-release": { parameters: { @@ -103521,7 +108950,8 @@ export interface operations { }; /** * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + * @description > [!NOTE] + * > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ @@ -103580,6 +109010,7 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; }; path: { owner: components["parameters"]["owner"]; @@ -103616,8 +109047,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103699,6 +109129,9 @@ export interface operations { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-repo-ruleset": { parameters: { @@ -103745,8 +109178,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103813,6 +109244,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { owner: components["parameters"]["owner"]; @@ -103948,6 +109381,78 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "secret-scanning/create-push-protection-bypass": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + content: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + content: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + "secret-scanning/get-scan-history": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List repository security advisories * @description Lists security advisories in a repository. @@ -104145,7 +109650,8 @@ export interface operations { * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * > [!NOTE] + * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ "security-advisories/create-fork": { parameters: { @@ -104204,11 +109710,10 @@ export interface operations { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. + * > [!NOTE] + * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ "repos/get-code-frequency-stats": { parameters: { @@ -104264,7 +109769,8 @@ export interface operations { * * `d` - Number of deletions * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * > [!NOTE] + * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ "repos/get-contributors-stats": { parameters: { @@ -104512,8 +110018,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -104536,8 +110046,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -104567,8 +110081,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -104593,7 +110111,9 @@ export interface operations { * @description Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -104679,7 +110199,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -104883,7 +110403,8 @@ export interface operations { * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use * the `Location` header to make a second `GET` request. * - * **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ "repos/download-zipball-archive": { parameters: { @@ -105013,12 +110534,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + * @description **This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; per_page?: components["parameters"]["per-page"]; @@ -105092,7 +110613,8 @@ export interface operations { * * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * > [!NOTE] + * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ "search/issues-and-pull-requests": { parameters: { @@ -105297,7 +110819,8 @@ export interface operations { /** * Get a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ "teams/get-legacy": { parameters: { @@ -105318,7 +110841,8 @@ export interface operations { /** * Delete a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -105342,11 +110866,13 @@ export interface operations { /** * Update a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -105381,7 +110907,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -105412,7 +110938,8 @@ export interface operations { /** * List discussions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * * List all discussions on a team's page. * @@ -105444,11 +110971,12 @@ export interface operations { /** * Create a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -105485,7 +111013,8 @@ export interface operations { /** * Get a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * * Get a specific discussion on a team's page. * @@ -105510,7 +111039,8 @@ export interface operations { /** * Delete a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * * Delete a discussion from a team's page. * @@ -105533,7 +111063,8 @@ export interface operations { /** * Update a discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * @@ -105568,7 +111099,8 @@ export interface operations { /** * List discussion comments (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * * List all comments on a team discussion. * @@ -105601,11 +111133,12 @@ export interface operations { /** * Create a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ @@ -105636,7 +111169,8 @@ export interface operations { /** * Get a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * * Get a specific comment on a team discussion. * @@ -105662,7 +111196,8 @@ export interface operations { /** * Delete a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * * Deletes a comment on a team discussion. * @@ -105686,7 +111221,8 @@ export interface operations { /** * Update a discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * * Edits the body text of a discussion comment. * @@ -105720,7 +111256,8 @@ export interface operations { /** * List reactions for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -105763,7 +111300,8 @@ export interface operations { /** * Create reaction for a team discussion comment (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * @@ -105810,7 +111348,8 @@ export interface operations { /** * List reactions for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -105852,7 +111391,8 @@ export interface operations { /** * Create reaction for a team discussion (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * @@ -105898,7 +111438,8 @@ export interface operations { /** * List pending team invitations (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ @@ -105927,7 +111468,8 @@ export interface operations { /** * List team members (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * * Team members will include the members of child teams. */ @@ -105959,7 +111501,7 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * @@ -105986,7 +111528,7 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * @@ -105994,7 +111536,8 @@ export interface operations { * * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ @@ -106024,7 +111567,7 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * @@ -106032,7 +111575,8 @@ export interface operations { * * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-member-legacy": { parameters: { @@ -106055,7 +111599,8 @@ export interface operations { /** * Get team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * * Team members will include the members of child teams. * @@ -106086,13 +111631,15 @@ export interface operations { /** * Add or update team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * @@ -106138,13 +111685,15 @@ export interface operations { /** * Remove team membership for a user (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * * Team synchronization is available for organizations using 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. * * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * > [!NOTE] + * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ "teams/remove-membership-for-user-legacy": { parameters: { @@ -106167,7 +111716,8 @@ export interface operations { /** * List team projects (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * * Lists the organization projects for a team. */ @@ -106197,7 +111747,8 @@ export interface operations { /** * Check team permissions for a project (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ @@ -106224,7 +111775,8 @@ export interface operations { /** * Add or update team project permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ @@ -106267,7 +111819,8 @@ export interface operations { /** * Remove a project from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ @@ -106290,7 +111843,8 @@ export interface operations { /** * List team repositories (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ "teams/list-repos-legacy": { parameters: { @@ -106318,11 +111872,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * > [!NOTE] + * > Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -106352,7 +111908,8 @@ export interface operations { /** * Add or update team repository permissions (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * @@ -106389,7 +111946,8 @@ export interface operations { /** * Remove a repository from a team (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ @@ -106411,7 +111969,8 @@ export interface operations { /** * List child teams (Legacy) * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ "teams/list-child-legacy": { parameters: { @@ -106661,7 +112220,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -106693,7 +112252,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -107472,6 +113031,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -107677,6 +113237,8 @@ export interface operations { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -107698,6 +113260,8 @@ export interface operations { /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -107776,10 +113340,8 @@ export interface operations { * List user account issues assigned to the authenticated user * @description List issues across owned and member repositories assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * > [!NOTE] + * > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * @@ -108311,6 +113873,9 @@ export interface operations { * @description List organizations for the authenticated user. * * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -108338,7 +113903,7 @@ export interface operations { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-authenticated-user": { parameters: { @@ -108370,7 +113935,7 @@ export interface operations { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-authenticated-user": { parameters: { @@ -108392,7 +113957,7 @@ export interface operations { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-authenticated-user": { parameters: { @@ -108419,7 +113984,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-authenticated-user": { parameters: { @@ -108446,7 +114011,7 @@ export interface operations { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { @@ -108477,7 +114042,7 @@ export interface operations { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-authenticated-user": { parameters: { @@ -108502,7 +114067,7 @@ export interface operations { * * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-authenticated-user": { parameters: { @@ -108530,7 +114095,7 @@ export interface operations { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-authenticated-user": { parameters: { @@ -108754,7 +114319,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -108771,7 +114338,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -109245,6 +114814,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + */ + "users/get-by-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. @@ -109298,6 +114893,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "users/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + bundle?: components["schemas"]["sigstore-bundle-0"]; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + }; + }; /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. @@ -109323,7 +114965,10 @@ export interface operations { }; /** * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-events-for-authenticated-user": { parameters: { @@ -109347,6 +114992,9 @@ export interface operations { /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-org-events-for-authenticated-user": { parameters: { @@ -109368,7 +115016,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-public-events-for-user": { parameters: { query?: { @@ -109623,7 +115275,7 @@ export interface operations { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/list-packages-for-user": { parameters: { @@ -109660,7 +115312,7 @@ export interface operations { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-for-user": { parameters: { @@ -109685,7 +115337,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-for-user": { parameters: { @@ -109715,7 +115367,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-for-user": { parameters: { @@ -109743,7 +115395,7 @@ export interface operations { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { @@ -109769,7 +115421,7 @@ export interface operations { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/get-package-version-for-user": { parameters: { @@ -109795,7 +115447,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/delete-package-version-for-user": { parameters: { @@ -109826,7 +115478,7 @@ export interface operations { * * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ "packages/restore-package-version-for-user": { parameters: { @@ -109878,7 +115530,11 @@ export interface operations { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the + * given user, you will see private events. Otherwise, you'll only see public events. + * + * > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ "activity/list-received-events-for-user": { parameters: { @@ -109899,7 +115555,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @description > [!NOTE] + * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + */ "activity/list-received-public-events-for-user": { parameters: { query?: { @@ -110228,4 +115888,34 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List organization fine-grained permissions for an organization + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "orgs/list-organization-fine-grained-permissions": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; }